Skip to content

feature: support for auto-generated swagger docs #19

@ayushanand18

Description

@ayushanand18

Auto-generated swagger docs on /docs or a customizable endpoint.

Both HttpMethod, and Websocket interfaces have these method which would help us implement it -

type Method interface {
	...
	WithDescription(desc string) Method
	WithInputSchema(schema interface{}) Method
	WithOutputSchema(schema interface{}) Method
	WithName(name string) Method
	...
}
type WebSocket interface {
	...
	// Name of the websocket endpoint - for Swagger API documentation
	WithName(name string) WebSocket
	// Description of the websocket endpoint - for Swagger API documentation
	WithDescription(desc string) WebSocket
	...
}

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions