Swagger spec, docs, and client

mozey / httprouter-util

Example of using httprouter and other useful packages

2 stars 0 forks source link

Swagger spec, docs, and client #3

Open mozey opened 1 year ago

mozey commented 1 year ago

Do the following

Document endpoints in handler comments
Generate spec with swag
Endpoint to serve UI

mozey commented 1 year ago

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 commented 1 year ago

List of tools for generating a TypeScript,

Swagger Codegen
OpenAPI Generator
Plugin for openapi-generator-typescript-fetch-api

and Golang client

Swagger Codegen
OpenAPI Generator

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