Skip to content
This repository has been archived by the owner on Jan 6, 2022. It is now read-only.

Spec the API using Swagger #36

Open
pfrazee opened this issue Jan 3, 2017 · 0 comments
Open

Spec the API using Swagger #36

pfrazee opened this issue Jan 3, 2017 · 0 comments

Comments

@pfrazee
Copy link
Collaborator

pfrazee commented Jan 3, 2017

Swagger is a spec and toolset for specifying Web APIs using YAML. It's also part of the OpenAPI standard. The advantages of using it are:

  • Concise specification language, in yaml (yay)
  • Automatic code generation for both client and server, if you want it
  • Automatic documentation generation (very handy)
  • Automatic test generation

You can see example specs, and the auto-generated documentation (on right), in their editor app: http://editor.swagger.io/#/

We could host the auto-generated docs as the HTML response to the /v1/ endpoint.

garbados pushed a commit to garbados/hypercloud that referenced this issue Aug 14, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant