3.0.0
Support Schema
Generate schema yaml like this:
- Schema
- openapi
- info
- tags
- paths
- externalDocs
- servers
- security
- components
- schemas
- requestBodies
- securitySchemes
- parameters
- responses (experimental)
- examples (experimental)
- headers (experimental)
- links (experimental)
- callbacks (experimental)
openapi
Support field like this:
| field name | field type |
|---|---|
openapi | string |
info
Support field like this:
| field name | field type |
|---|---|
title | string |
description | string |
termsOfService | string |
contact | Contact Object |
license | License Object |
version | string |
tags
Support field like this:
| field name | field type |
|---|---|
name | string |
description | string |
externalDocs | External Document Object |
paths
Support field like this:
| field name | field type |
|---|---|
/{path} | Path Item Object |
for example:
paths:
"/users":
post:
tags:
- user
summary: post summary
description: post description
responses:
default:
description: ''
deprecated: false
"/{model_name}/{id}":
get:
tags:
- rails_admin/main
summary: get summary
description: get description
responses:
default:
description: ''
'200':
description: rails_admin/main description
content:
application/json:
schema:
"$ref": "#/components/schemas/Main"
deprecated: false
parameters:
- name: model_name
in: path
description: model_name
required: true
schema:
type: string
- name: id
in: path
description: id
required: true
schema:
type: integer
externalDocs
Support field like this:
| field name | field type |
|---|---|
description | string |
url | string |
servers
Support field like this:
| field name | field type |
|---|---|
url | string |
description | string |
components
Support field like this:
| field name | field type |
|---|---|
schemas | Schema Object |
requestBodies | Request Body Object |
securitySchemes | Security Schemes Object |
parameters | Parameter Object |
responses | Response Object |
examples | Example Object |
headers | Header Object |
links | Link Object |
callbacks | Callback Object |