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

Provide REST API documentation per instance #228

Closed
ledsoft opened this issue Apr 13, 2023 · 0 comments
Closed

Provide REST API documentation per instance #228

ledsoft opened this issue Apr 13, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@ledsoft
Copy link
Contributor

ledsoft commented Apr 13, 2023

Currently, the REST API documentation is maintained manually at SwaggerHub. However, this is quite inefficient for two reasons:

  1. Manual maintenance in a separate place than the source code makes it often outdated,
  2. Testing the API is difficult because different instances would require different versions on SwaggerHub.

Instead, the documentation should be a part of each deployment of TermIt so that it can be directly tested. Moreover, the documentation of the endpoints would be specified directly in code. Springdoc OpenAPI could be used for this purpose.

@ledsoft ledsoft added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 13, 2023
ledsoft added a commit that referenced this issue May 9, 2023
…ntation with Swagger UI as part of the application deployment.
ledsoft added a commit that referenced this issue May 9, 2023
ledsoft added a commit that referenced this issue May 16, 2023
…ller.

Minor refactoring of the API documentation constants.
@ledsoft ledsoft closed this as completed May 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant