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

Migrate to scalar #77

Merged
merged 4 commits into from
Mar 2, 2025
Merged

Migrate to scalar #77

merged 4 commits into from
Mar 2, 2025

Conversation

CodeName-Anti
Copy link
Collaborator

This pull request includes several changes to update the API documentation and improve the server configuration. The most important changes include replacing swagger-ui-express with @scalar/express-api-reference, updating the OpenAPI specification file name, and modifying the NGINX configuration to handle the new OpenAPI endpoint.

API Documentation Updates:

  • backend/package.json: Removed swagger-ui-express and added @scalar/express-api-reference to dependencies.
  • backend/src/server.ts: Replaced the Swagger UI setup with the apiReference middleware from @scalar/express-api-reference, and updated the endpoint for serving the OpenAPI specification file. [1] [2]
  • backend/tsoa.json: Changed the OpenAPI specification file name to openapi.

Server Configuration:

  • nginx/nginx.conf: Updated the NGINX configuration to proxy requests for openapi.json to the backend.

@CodeName-Anti CodeName-Anti added the enhancement New feature, improvement or request label Mar 2, 2025
Copy link
Owner

@schmolldechse schmolldechse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your hard work!

Copy link
Owner

@schmolldechse schmolldechse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be good if you lint, then I can merge your changes.

Copy link
Owner

@schmolldechse schmolldechse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Looks good now

@CodeName-Anti CodeName-Anti merged commit 2accc00 into dev Mar 2, 2025
2 checks passed
@schmolldechse schmolldechse deleted the migrate-scalar branch March 3, 2025 13:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature, improvement or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants