Skip to content
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.

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

How to document cnd's HTTP API #38

Merged
merged 20 commits into from
Sep 3, 2019
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
Fix image links
  • Loading branch information
luckysori committed Sep 3, 2019
commit dfdc433624f9998a10bdfa3dd3b0f6e9aa033b84
6 changes: 3 additions & 3 deletions 0015-how-to-document-cnd-http-api.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ Fortunately, this specification will be <<test-specification,tested>> and we can
* Extremely popular (over 15k stars on https://github.com/swagger-api/swagger-ui[GitHub]).
* RPC-style.
* Looks like this:
image::How_to_visualise_documentation/Swagger_UI_2019-08-29_18-16-23.png[scaledwidth=100%]
image::https://swagger.io/swagger/media/Images/Tools/Opensource/Swagger_UI.png?ext=.png[swagger-ui-image]

* Hides JSON bodies.

Expand All @@ -181,13 +181,13 @@ image::How_to_visualise_documentation/Swagger_UI_2019-08-29_18-16-23.png[scaledw
* Very https://github.com/Redocly/redoc/#deployment[simple] to set up.
* Three-column style.
* It looks very good:
image::How_to_visualise_documentation/redoc-demo_2019-08-29_18-29-34.png[scaledwidth=100%]
image::https://raw.githubusercontent.com/Redocly/redoc/master/demo/redoc-demo.png[redoc-image]

===== http:https://cheesestore.github.io/[Spectacle] =====

* Quite popular (about 1k stars on GitHub).
* Looks similar to ReDoc:
image::How_to_visualise_documentation/screenshot_2019-08-29_18-46-24.jpg[scaledwidth=100%]
image::https://raw.githubusercontent.com/sourcey/spectacle/master/screenshot.jpg[spectacle-image]

==== Recommendation ====

Expand Down