README
¶
Gindocnic
A library for generating OpenAPI 3.1 documentation for the Gin Web Framework.
Contributing
- The layout of this module loosely follows a basic layout for Go application projects.
Documentation
¶
Overview ¶
Package gindocnic
Index ¶
- func RequestContentType(contentType string) func(ro *requestOptions)
- func ResponseStatus(status int) responseOption
- type Doc
- func (d *Doc) AssocRoutesInfo(routes gin.RoutesInfo) error
- func (d *Doc) MarshalYAML() ([]byte, error)
- func (d *Doc) Operation(h gin.HandlerFunc, opts ...PathItemSpecFunc) gin.HandlerFunc
- func (d *Doc) WithLicense(name, url string) *Doc
- func (d *Doc) WithSecurity(securities map[string][]string) *Doc
- func (d *Doc) WithServer(url string) *Doc
- func (d *Doc) WithSummary(summary string) *Doc
- type PathItemSpec
- type PathItemSpecFunc
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RequestContentType ¶
func RequestContentType(contentType string) func(ro *requestOptions)
RequestContentType リクエストのContent-Typeを設定します。 AddRequestの可変長引数に渡してください。
func ResponseStatus ¶
func ResponseStatus(status int) responseOption
Types ¶
type Doc ¶
type Doc struct {
// contains filtered or unexported fields
}
Doc OpenAPI定義書の全体の情報をもちます。
func (*Doc) AssocRoutesInfo ¶
func (d *Doc) AssocRoutesInfo(routes gin.RoutesInfo) error
AssocRoutesInfo リクエストハンドラをパスやHTTPメソッドと関連づけて、Open API仕様書に必要な情報をそろえます。
func (*Doc) MarshalYAML ¶
MarshalYAML yaml形式のOpen API定義をバイト列で返します。
func (*Doc) Operation ¶
func (d *Doc) Operation(h gin.HandlerFunc, opts ...PathItemSpecFunc) gin.HandlerFunc
Operation
func (*Doc) WithLicense ¶
WithSummary [info-object]のlicenseを登録します。 [info-object]: https://spec.openapis.org/oas/v3.1.0.html#info-object
func (*Doc) WithSecurity ¶
WithSecurity [Security Scheme Object]を登録します。 一部のAPIで求められる認証の形式を宣言します。Basic認証やOpen ID Connectなどを指定できます。 Open APIの仕様上必須のフィールドらしいです。 [Security Scheme Object]: https://spec.openapis.org/oas/v3.1.0.html#security-scheme-object
func (*Doc) WithServer ¶
WithServer [server]を登録します。 [server]: https://spec.openapis.org/oas/v3.1.0.html#server-object
func (*Doc) WithSummary ¶
WithSummary [info-object]のsummaryを登録します。 [info-object]: https://spec.openapis.org/oas/v3.1.0.html#info-object
type PathItemSpec ¶
type PathItemSpec struct {
// contains filtered or unexported fields
}
PathItemSpec [path-item-object]の生成に必要な情報をもちます。 もともとはOperationOptionsという名前でしたが、[コードレビューのコメント]とoperationより上位の path-itemのスキーマにあるhttp methodやpathを含む構造体なので、PathItemSpecに名前を変えました。 [コードレビューのコメント]: https://github.com/alpdr/data-platform/pull/481#discussion_r1804170012 [path-item-object]: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#path-item-object
func (*PathItemSpec) AddRequest ¶
func (o *PathItemSpec) AddRequest(body any, opts ...requestOption)
AddRequest Operationにリクエストを追加します。
func (*PathItemSpec) AddResponse ¶
func (o *PathItemSpec) AddResponse(body any, opts ...responseOption)
func (*PathItemSpec) SetMethod ¶
func (o *PathItemSpec) SetMethod(method string)
func (*PathItemSpec) SetPath ¶
func (o *PathItemSpec) SetPath(path string)
func (*PathItemSpec) SetSummary ¶
func (o *PathItemSpec) SetSummary(s string)
Source Files
Directories