Skip to content

generate Swagger documentation for API #35

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

Open
1 of 2 tasks
tenkus47 opened this issue May 16, 2025 · 1 comment
Open
1 of 2 tasks

generate Swagger documentation for API #35

tenkus47 opened this issue May 16, 2025 · 1 comment
Assignees

Comments

@tenkus47
Copy link
Member

tenkus47 commented May 16, 2025

Summary

This RFC proposes integrating Swagger (OpenAPI Specification) to standardize and automate the documentation of our API. Swagger will provide a clear, interactive, and up-to-date interface for developers, QA, and third-party consumers to understand and test the API endpoints.

🧩 Alternatives Considered

Option Pros Cons
Manual Markdown Docs Simple to write Easy to become outdated, no interactivity
Postman Collections Good for testing Not standardized, no integration with CI/CD
Redoc Clean UI, OpenAPI-based Less interactive than Swagger UI

steps:

  • integrate swagger docs
  • Validate RESTful Conventions
@tenkus47 tenkus47 moved this to In Progress in Pecha Tools May 16, 2025
@tenkus47 tenkus47 self-assigned this May 16, 2025
@tenkus47
Copy link
Member Author

@tenkus47 tenkus47 moved this from In Progress to Blocked in Pecha Tools May 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Blocked
Development

No branches or pull requests

1 participant