-
-
Notifications
You must be signed in to change notification settings - Fork 96
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #845 from samchon/features/migrate
`@nestia/migrate` support to every swagger versions.
- Loading branch information
Showing
12 changed files
with
294 additions
and
26 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,222 @@ | ||
{ | ||
"swagger": "2.0", | ||
"info": { | ||
"version": "1.0.0", | ||
"title": "Swagger Petstore", | ||
"description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification", | ||
"termsOfService": "http://swagger.io/terms/", | ||
"contact": { | ||
"name": "Swagger API Team" | ||
}, | ||
"license": { | ||
"name": "MIT" | ||
} | ||
}, | ||
"host": "petstore.swagger.io", | ||
"basePath": "/api", | ||
"schemes": [ | ||
"http" | ||
], | ||
"consumes": [ | ||
"application/json" | ||
], | ||
"produces": [ | ||
"application/json" | ||
], | ||
"paths": { | ||
"/pets": { | ||
"get": { | ||
"description": "Returns all pets from the system that the user has access to", | ||
"operationId": "findPets", | ||
"produces": [ | ||
"application/json", | ||
"application/xml", | ||
"text/xml", | ||
"text/html" | ||
], | ||
"parameters": [ | ||
{ | ||
"name": "tags", | ||
"in": "query", | ||
"description": "tags to filter by", | ||
"required": false, | ||
"type": "array", | ||
"items": { | ||
"type": "string" | ||
}, | ||
"collectionFormat": "csv" | ||
}, | ||
{ | ||
"name": "limit", | ||
"in": "query", | ||
"description": "maximum number of results to return", | ||
"required": false, | ||
"type": "integer", | ||
"format": "int32" | ||
} | ||
], | ||
"responses": { | ||
"200": { | ||
"description": "pet response", | ||
"schema": { | ||
"type": "array", | ||
"items": { | ||
"$ref": "#/definitions/Pet" | ||
} | ||
} | ||
}, | ||
"default": { | ||
"description": "unexpected error", | ||
"schema": { | ||
"$ref": "#/definitions/ErrorModel" | ||
} | ||
} | ||
} | ||
}, | ||
"post": { | ||
"description": "Creates a new pet in the store. Duplicates are allowed", | ||
"operationId": "addPet", | ||
"produces": [ | ||
"application/json" | ||
], | ||
"parameters": [ | ||
{ | ||
"name": "pet", | ||
"in": "body", | ||
"description": "Pet to add to the store", | ||
"required": true, | ||
"schema": { | ||
"$ref": "#/definitions/NewPet" | ||
} | ||
} | ||
], | ||
"responses": { | ||
"200": { | ||
"description": "pet response", | ||
"schema": { | ||
"$ref": "#/definitions/Pet" | ||
} | ||
}, | ||
"default": { | ||
"description": "unexpected error", | ||
"schema": { | ||
"$ref": "#/definitions/ErrorModel" | ||
} | ||
} | ||
} | ||
} | ||
}, | ||
"/pets/{id}": { | ||
"get": { | ||
"description": "Returns a user based on a single ID, if the user does not have access to the pet", | ||
"operationId": "findPetById", | ||
"produces": [ | ||
"application/json", | ||
"application/xml", | ||
"text/xml", | ||
"text/html" | ||
], | ||
"parameters": [ | ||
{ | ||
"name": "id", | ||
"in": "path", | ||
"description": "ID of pet to fetch", | ||
"required": true, | ||
"type": "integer", | ||
"format": "int64" | ||
} | ||
], | ||
"responses": { | ||
"200": { | ||
"description": "pet response", | ||
"schema": { | ||
"$ref": "#/definitions/Pet" | ||
} | ||
}, | ||
"default": { | ||
"description": "unexpected error", | ||
"schema": { | ||
"$ref": "#/definitions/ErrorModel" | ||
} | ||
} | ||
} | ||
}, | ||
"delete": { | ||
"description": "deletes a single pet based on the ID supplied", | ||
"operationId": "deletePet", | ||
"parameters": [ | ||
{ | ||
"name": "id", | ||
"in": "path", | ||
"description": "ID of pet to delete", | ||
"required": true, | ||
"type": "integer", | ||
"format": "int64" | ||
} | ||
], | ||
"responses": { | ||
"204": { | ||
"description": "pet deleted" | ||
}, | ||
"default": { | ||
"description": "unexpected error", | ||
"schema": { | ||
"$ref": "#/definitions/ErrorModel" | ||
} | ||
} | ||
} | ||
} | ||
} | ||
}, | ||
"definitions": { | ||
"Pet": { | ||
"type": "object", | ||
"allOf": [ | ||
{ | ||
"$ref": "#/definitions/NewPet" | ||
}, | ||
{ | ||
"required": [ | ||
"id" | ||
], | ||
"properties": { | ||
"id": { | ||
"type": "integer", | ||
"format": "int64" | ||
} | ||
} | ||
} | ||
] | ||
}, | ||
"NewPet": { | ||
"type": "object", | ||
"required": [ | ||
"name" | ||
], | ||
"properties": { | ||
"name": { | ||
"type": "string" | ||
}, | ||
"tag": { | ||
"type": "string" | ||
} | ||
} | ||
}, | ||
"ErrorModel": { | ||
"type": "object", | ||
"required": [ | ||
"code", | ||
"message" | ||
], | ||
"properties": { | ||
"code": { | ||
"type": "integer", | ||
"format": "int32" | ||
}, | ||
"message": { | ||
"type": "string" | ||
} | ||
} | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
import { OpenAPIV2 } from "openapi-types"; | ||
|
||
export interface ISwaggerV20 | ||
extends Omit<OpenAPIV2.Document, "swagger">, | ||
ISwaggerV20.IVersion {} | ||
export namespace ISwaggerV20 { | ||
export interface IVersion { | ||
swagger: "2.0"; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
import { OpenAPIV3_1 } from "openapi-types"; | ||
|
||
export interface ISwaggerV31 extends Omit<OpenAPIV3_1.Document, "openapi"> { | ||
openapi: `3.1.${number}`; | ||
} | ||
export namespace ISwaggerV31 { | ||
export interface IVersion { | ||
openapi: `3.1.${number}`; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
import V2_0Converter from "swagger2openapi"; | ||
import typia from "typia"; | ||
|
||
import { Converter as V3_1Converter } from "@apiture/openapi-down-convert"; | ||
|
||
import { ISwagger } from "../structures/ISwagger"; | ||
import { ISwaggerV20 } from "../structures/ISwaggerV20"; | ||
import { ISwaggerV31 } from "../structures/ISwaggerV31"; | ||
|
||
export namespace OpenApiConverter { | ||
export const v2_0 = async (swagger: ISwaggerV20): Promise<ISwagger> => { | ||
const output = await V2_0Converter.convertObj(swagger, {}); | ||
return typia.assert<ISwagger>(output.openapi); | ||
}; | ||
|
||
export const v3_1 = (swagger: ISwaggerV31): ISwagger => { | ||
const converter = new V3_1Converter(swagger); | ||
return typia.assert<ISwagger>(converter.convert() as ISwagger); | ||
}; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters