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.

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

Jump to bottom

Create API specification #21

Open
briggySmalls opened this issue Mar 5, 2020 · 1 comment
Open

Create API specification #21

briggySmalls opened this issue Mar 5, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@briggySmalls
Copy link
Owner

This project exposes an API for generating diagrams.

This could be specified using the openAPI specification within this project. This would enable:

  • Easier consumption by clients. For example, clients could be generated using Swagger tools.
  • The server could be generated from the API using a too like go-swagger which would remove manual boilerplate
  • Serve swagger UI for documentation of the API
@briggySmalls
Copy link
Owner Author

Note: go-swagger seems to claim it can generate an API specification from golang source.

@briggySmalls briggySmalls added enhancement New feature or request documentation Improvements or additions to documentation and removed enhancement New feature or request labels Mar 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@briggySmalls