Skip to content

[WIP] add OpenAPI description and Swagger UI #1347

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
Closed
wants to merge 3 commits into from
Closed

[WIP] add OpenAPI description and Swagger UI #1347

wants to merge 3 commits into from

Conversation

@tkurki
Copy link
Member

@tkurki tkurki commented Oct 3, 2021

Add OpenAPI description of the Signal K api and Swagger UI at /api-docs.

@tkurki
Copy link
Member Author

tkurki commented Oct 3, 2021

I started with tracks api, even if it is not yet supported in the server core nor in the specification, to get some practical experience with this. We should explore moving the description to the specification repo & package. I believe going forward we will need more explicit http apis with associated parameters and response formats. So this is a start in that direction, creating tooling for documentation and interactive, eploratory usage.

@tkurki
feature: allow plugins to contribute paths
c249dc6 
Make openapi.json explicitly served for standalone use
and to make it dynamic.

Add a mechanism for plugins to contribute 'paths' to the main
openapi.json, so that plugins can provide openapi descriptions
of their http APIs.
@tkurki tkurki mentioned this pull request Nov 13, 2021
Open
@tkurki
Copy link
Member Author

tkurki commented Mar 27, 2022

Included in #1381.

@tkurki tkurki closed this Mar 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tkurki