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.

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

Swagger spec, docs, and client #3

Open
mozey opened this issue Nov 24, 2022 · 3 comments
Open

Swagger spec, docs, and client #3

mozey opened this issue Nov 24, 2022 · 3 comments

Comments

@mozey
Copy link
Owner

mozey commented Nov 24, 2022

Do the following

  • Document endpoints in handler comments
  • Generate spec with swag
  • Endpoint to serve UI
@mozey mozey mentioned this issue Nov 24, 2022
Closed
@mozey
Copy link
Owner Author

mozey commented Nov 24, 2022

Related to #4

@mozey
Copy link
Owner Author

mozey commented Nov 24, 2022

The Swagger lib mentioned above requires manually updating comment annotations. Using bufbuild for "browser and gRPC-compatible HTTP APIs" with protobuf requires less boilerplate. However, does it include an interactive UI for exploring the API like Swagger does?

@mozey
Copy link
Owner Author

mozey commented Nov 30, 2022 •
edited
Loading

List of tools for generating a TypeScript,

and Golang client

The OpenAPI Generator is available for install via Homebrew, or Docker image

@mozey mozey changed the title Swagger docs Swagger spec, docs, and client Nov 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mozey