mirror of
https://github.com/robindhole/sfg-restdocs-example.git
synced 2025-09-13 19:42:35 +00:00
adding maven config
This commit is contained in:
29
src/main/asciidoc/index.adoc
Normal file
29
src/main/asciidoc/index.adoc
Normal file
@@ -0,0 +1,29 @@
|
||||
= SFG Brewery Order Service Docs
|
||||
John Thompson;
|
||||
:doctype: book
|
||||
:icons: font
|
||||
:source-highlighter: highlightjs
|
||||
|
||||
Sample application demonstrating how to use Spring REST Docs with JUnit 5.
|
||||
|
||||
`BeerOrderControllerTest` makes a call to a very simple service and produces three
|
||||
documentation snippets.
|
||||
|
||||
One showing how to make a request using cURL:
|
||||
|
||||
include::{snippets}/orders/curl-request.adoc[]
|
||||
|
||||
One showing the HTTP request:
|
||||
|
||||
include::{snippets}/orders/http-request.adoc[]
|
||||
|
||||
And one showing the HTTP response:
|
||||
|
||||
include::{snippets}/orders/http-response.adoc[]
|
||||
|
||||
Response Body:
|
||||
include::{snippets}/orders/response-body.adoc[]
|
||||
|
||||
|
||||
Response Fields:
|
||||
include::{snippets}/orders/response-fields.adoc[]
|
Reference in New Issue
Block a user