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

Add Swagger Serving Command #812

Merged

Conversation

devleejb
Copy link
Member

@devleejb devleejb commented Mar 5, 2024

What this PR does / why we need it:

image

This PR focuses on defining the ConnectRPC API Docs as an OpenAPI Spec and includes adding a Swagger serving command. By converting the API docs to an OpenAPI Spec, it enhances the readability, consistency, and ease of use for developers utilizing the ConnectRPC API.

Which issue(s) this PR fixes:

Fixes #804

Special notes for your reviewer:

To access swagger, run make docker-swagger and access to localhost:3000.

Does this PR introduce a user-facing change?:


Additional documentation:


Checklist:

  • Added relevant tests or not required
  • Didn't break anything

@devleejb devleejb added the documentation 📔 Improvements or additions to documentation label Mar 5, 2024
@devleejb devleejb self-assigned this Mar 5, 2024
@devleejb devleejb linked an issue Mar 5, 2024 that may be closed by this pull request
Copy link

codecov bot commented Mar 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 50.71%. Comparing base (0987cbc) to head (e0e32ca).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #812   +/-   ##
=======================================
  Coverage   50.71%   50.71%           
=======================================
  Files          70       70           
  Lines       10213    10213           
=======================================
  Hits         5180     5180           
  Misses       4512     4512           
  Partials      521      521           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@hackerwins hackerwins requested review from krapie and hackerwins March 6, 2024 00:06
Copy link
Member

@hackerwins hackerwins 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 contribution.

@hackerwins hackerwins changed the title Define ConnectRPC API Docs as OpenAPI Spec and Add Swagger Serving Command Add Swagger Serving Command Mar 6, 2024
@hackerwins hackerwins merged commit c86999d into main Mar 6, 2024
4 checks passed
@hackerwins hackerwins deleted the 804-add-connectrpc-spec-definition-for-api-documentation branch March 6, 2024 02:59
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add ConnectRPC Spec Definition for API Documentation
2 participants