Skip to content

Add note about non-json content-types to README.md, see #122 #123 #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 23, 2020
Merged

Add note about non-json content-types to README.md, see #122 #123 #124

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9bd80cc
Add note about non-json content-types to README.md, see #122 #123
Jan 23, 2020
8a79ef6
Adopt suggestions to README.md
lgaida Jan 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ It currently supports:
We plan to add support for:
- [RAML](https://raml.org)

Please note that this extension was developed for JSON-based APIs.
We do not expect this extension to build usable API specification for non-JSON request or response bodies.

## Motivation

[Spring REST Docs](https://projects.spring.io/spring-restdocs/) is a great tool to produce documentation for your RESTful services that is accurate and readable.
Expand Down Expand Up @@ -560,4 +563,3 @@ See [openapi2raml.gradle](samples/restdocs-api-spec-sample/openapi2raml.gradle).
./gradlew restdocs-api-spec-sample:openapi
./gradlew -b samples/restdocs-api-spec-sample/openapi2raml.gradle openapi2raml
```