Maybe this can help: swagger: ‘2.0’ info: version: 1.0.0 title: Bearer auth example description: > An example for how to use Bearer Auth with OpenAPI / Swagger 2.0. host: basic-auth-server.herokuapp.com schemes: – http – https securityDefinitions: Bearer: type: apiKey name: Authorization in: header description: >- Enter the token with the `Bearer: ` prefix, e.g. “Bearer … Read more
I wrote a quick tool to do this recently. I call it openapi-merge. There is a library and an associated CLI tool: https://www.npmjs.com/package/openapi-merge https://www.npmjs.com/package/openapi-merge-cli In order to use the CLI tool you just write a configuration file and then run npx openapi-merge-cli. The configuration file is fairly simple and would look something like this: { … Read more
I search for generic types much time, but there is no way to define a generic type in OpenAPI3. The simplest way is using allOf and $ref at the same time. Suppose there is a list schema as follow: List: type: object properties: page_number: type: integer page_count: type: integer And the book schema is Book: … Read more
You actually ask several questions in one, and I’ll try answering them all. In Swagger 1.2 and prior to it, the file splitting was mandatory and artificial. It was meant as a way to group operations, and Swagger 2.0 offers and alternative method to do that (more on it soon). Swagger 2.0 is indeed a … Read more
It depends on what kind of parameters they are. The examples below are in YAML (for readability), but you can use http://www.json2yaml.com to convert them to JSON. Security-related parameters: Authorization header, API keys, etc. Parameters used for authentication and authorization, such as the Authorization header, API key, pair of API keys, etc. should be defined … Read more
In your example, you can use a single model for both GET and POST/PUT, with properties only used in the GET response marked as readOnly. From the spec: readOnly Declares the property as “read only”. This means that it MAY be sent as part of a response but MUST NOT be sent as part of … Read more
To turn off swagger validator add validatorUrl : null, in dist/index.html in window.swaggerUi = new SwaggerUi({ url: url, validatorUrl : null, dom_id: “swagger-ui-container”,
OpenAPI 3.1 Define the property as anyOf of the $ref and type: ‘null’. YAML version: foo: anyOf: – type: ‘null’ # Note the quotes around ‘null’ – $ref: ‘#/components/schemas/Foo’ JSON version: “foo”: { “anyOf”: [ { “type”: “null” }, { “$ref”: “#/components/schemas/Foo” } ] } Why use anyOf and not oneOf? oneOf will fail validation … Read more
Swagger Editor Paste your OpenAPI 2.0 definition into https://editor.swagger.io and select Edit > Convert to OpenAPI 3 from the menu. Swagger Converter Converts OpenAPI 2.0 and Swagger 1.x definitions to OpenAPI 3.0. https://converter.swagger.io/api/convert?url=OAS2_YAML_OR_JSON_URL This gives you JSON. If you want YAML, send the request with the Accept: application/yaml header: curl “https://converter.swagger.io/api/convert?url=OAS2_YAML_OR_JSON_URL” -H “Accept: application/yaml” -o … Read more
OpenAPI (fka Swagger) Specification does not support conditional or mutually exclusive parameters (of any type). There is an open feature request: Support interdependencies between query parameters