Documentation
¶
Index ¶
- func Operation(summary string, opts ...OperationOpt) schema.Operation
- type OperationOpt
- func WithDeprecated() OperationOpt
- func WithDescription(description string) OperationOpt
- func WithErrorResponse(status int, description ...string) OperationOpt
- func WithFormRequest(r *jsonschema.Schema) OperationOpt
- func WithID(id string) OperationOpt
- func WithJSONRequest(r *jsonschema.Schema) OperationOpt
- func WithJSONResponse(status int, r *jsonschema.Schema) OperationOpt
- func WithMultipartRequest(r *jsonschema.Schema) OperationOpt
- func WithQuery(q *jsonschema.Schema) OperationOpt
- func WithRequest(contentType string, r *jsonschema.Schema) OperationOpt
- func WithResponse(status int, contentType string, r *jsonschema.Schema, description ...string) OperationOpt
- func WithSecurity(schemeName string, scopes ...string) OperationOpt
- func WithTags(tags ...string) OperationOpt
- func WithTextResponse(status int, description string) OperationOpt
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type OperationOpt ¶
type OperationOpt func(*opopt)
func WithDeprecated ¶
func WithDeprecated() OperationOpt
func WithDescription ¶
func WithDescription(description string) OperationOpt
func WithErrorResponse ¶
func WithErrorResponse(status int, description ...string) OperationOpt
func WithFormRequest ¶
func WithFormRequest(r *jsonschema.Schema) OperationOpt
func WithID ¶
func WithID(id string) OperationOpt
func WithJSONRequest ¶
func WithJSONRequest(r *jsonschema.Schema) OperationOpt
func WithJSONResponse ¶
func WithJSONResponse(status int, r *jsonschema.Schema) OperationOpt
func WithMultipartRequest ¶
func WithMultipartRequest(r *jsonschema.Schema) OperationOpt
func WithQuery ¶
func WithQuery(q *jsonschema.Schema) OperationOpt
func WithRequest ¶
func WithRequest(contentType string, r *jsonschema.Schema) OperationOpt
func WithResponse ¶
func WithResponse(status int, contentType string, r *jsonschema.Schema, description ...string) OperationOpt
func WithSecurity ¶
func WithSecurity(schemeName string, scopes ...string) OperationOpt
func WithTags ¶
func WithTags(tags ...string) OperationOpt
func WithTextResponse ¶
func WithTextResponse(status int, description string) OperationOpt
Directories
¶
| Path | Synopsis |
|---|---|
|
Package httphandler provides HTTP handler functions for an httprouter.Router.
|
Package httphandler provides HTTP handler functions for an httprouter.Router. |
|
Package schema provides Go types for the OpenAPI 3.1 specification.
|
Package schema provides Go types for the OpenAPI 3.1 specification. |
|
Package static contains embedded static files for the OpenAPI handler.
|
Package static contains embedded static files for the OpenAPI handler. |
Click to show internal directories.
Click to hide internal directories.