OpenAPI is a widely adopted specification for describing the structure and behavior of RESTful APIs in a standardized format, typically using JSON or YAML. It allows teams to define endpoints, parameters, request/response schemas, and authentication in a way that’s both human-readable and machine-processable.
Swagger is a set of open-source tools built around the OpenAPI Specification, used to design, document, and test APIs. Thanks to the OpenAPI implementation, Dawiso can ingest metadata from providers like Swagger, making it easier to document and govern APIs in tools like Dawiso.
Default hierarchy
In the chart below, you will find the organizational structure of OpenAPI objects. Objects are in represented in green and folders are in yellow.
Object types
Dawiso ingests the following objects from OpenAPI:
Tag
Maps to OpenAPI Tag object type.
| Source Attribute | Target Attribute in Dawiso |
|---|---|
| Description | Scanned Description |
Method
Maps to OpenAPI Method object type.
| Source Attribute | Target Attribute in Dawiso |
|---|---|
| Description | Scanned Description |
| Summary | Summary |
| Deprecated | Deprecated |
| Method | Method |
| Path | Path |
Parameter
Maps to OpenAPI Parameter object type.
| Source Attribute | Target Attribute in Dawiso |
|---|---|
| Description | Scanned Description |
| Schema | Schema |
| In | In |
| SchemaFormat | Schema format |
| SchemaType | Schema type |
| Required | Required |
Response
Maps to OpenAPI Response object type.
| Source Attribute | Target Attribute in Dawiso |
|---|---|
| Description | Scanned Description |
Method Request Body
Maps to OpenAPI Method Request Body object type.
| Source Attribute | Target Attribute in Dawiso |
|---|---|
| Description | Scanned Description |
| IsRequired | Required |
Request Body Content
Maps to OpenAPI Request Body Content object type.
| Source Attribute | Target Attribute in Dawiso |
|---|---|
| MediaType | Schema Type |
| Schema | Schema |
Schema
Maps to OpenAPI Schema object type.
| Source Attribute | Target Attribute in Dawiso |
|---|---|
| Definition | Schema |
Security Schema
Maps to OpenAPI Security Schema object type.
| Source Attribute | Target Attribute in Dawiso |
|---|---|
| Description | Scanned Description |
| In | In |
| Type | Type |
| BearerFormat | Bearer Format |
Information
Maps to OpenAPI Information object type.
| Source Attribute | Target Attribute in Dawiso |
|---|---|
| Description | Scanned Description |
| TermsOfService | Terms of Service |
| Version | Version |
| ContactName | Contact Name |
| ContactEmail | Contact Email |
| ContactUrl | Contact URL |
| LicenseName | License Name |
| LicenseUrl | License URL |