alihan/fastapi-openapi-to-postman
1
0
Fork 0
mirror of https://github.com/postmanlabs/openapi-to-postman.git synced 2022-11-29 22:05:00 +03:00
Code Issues Packages Projects Releases Wiki Activity

adding multifile swagger examples, adding tests to validate merging, merge and validate support for swagger 20

Browse Source
This commit is contained in:
Erik Mendoza
2022-04-19 19:33:26 -05:00
parent 90a191dc4c
commit ae43c43f6f
29 changed files with 661 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
lib/schemapack.js
View File

@@ -62,7 +62,9 @@ class SchemaPack {
validate() {
let input = this.input,
json,
specParseResult;
specParseResult,
isFolder = this.input.type === 'folder';
this.computedOptions = Object.assign({ isFolder }, this.computedOptions);
if (!input) {
return {
result: false,

5
lib/swaggerUtils/inputValidationSwagger.js
View File

@@ -4,9 +4,10 @@ module.exports = {
/**
* Validate Spec to check if some of the required fields are present.
* @param {Object} spec OpenAPI spec
* @param {object} options Validation options
* @return {Object} Validation result
*/
validateSpec: function (spec) {
validateSpec: function (spec, options) {
if (spec.swagger !== '2.0') {
return {
result: false,
@@ -19,7 +20,7 @@ module.exports = {
reason: 'The Swagger object must have an "info" property'
};
}
if (!(spec.info.title && spec.info.version)) {
if (!(spec.info.title && spec.info.version) && !options.isFolder) {
return {
result: false,
reason: 'The info property must have title and version defined'

5
lib/swaggerUtils/schemaUtilsSwagger.js
View File

@@ -9,11 +9,12 @@ module.exports = {
/**
* Parses an OAS string/object as a YAML or JSON
* @param {YAML/JSON} openApiSpec - The swagger 2.0 specification specified in either YAML or JSON
* @param {object} options true if input type is folder
* @returns {Object} - Contains the parsed JSON-version of the OAS spec, or an error
* @no-unit-test
*/
parseSpec: function (openApiSpec) {
return schemaUtilsCommon.parseSpec(openApiSpec, inputValidationSwagger);
parseSpec: function (openApiSpec, options) {
return schemaUtilsCommon.parseSpec(openApiSpec, inputValidationSwagger, options);
},
/**

9
test/data/swaggerMultifile/basicExample/index.yaml Normal file
View File

@@ -0,0 +1,9 @@
swagger: "2.0"
info:
$ref: ./info.yaml
host: api.example.com
basePath: /v1
schemes:
- https
paths:
$ref: ./paths.yaml

3
test/data/swaggerMultifile/basicExample/info.yaml Normal file
View File

@@ -0,0 +1,3 @@
title: Sample API
description: API description in Markdown.
version: 1.0.0

9
test/data/swaggerMultifile/basicExample/paths.yaml Normal file
View File

@@ -0,0 +1,9 @@
/users:
get:
summary: Returns a list of users.
description: Optional extended description in Markdown.
produces:
- application/json
responses:
200:
description: OK

4
test/data/swaggerMultifile/multifile-two-root-files/definitions/User.yaml Normal file
View File

@@ -0,0 +1,4 @@
type: object
properties:
name:
type: string

2
test/data/swaggerMultifile/multifile-two-root-files/definitions/index.yaml Normal file
View File

@@ -0,0 +1,2 @@
User:
$ref: ./User.yaml

7
test/data/swaggerMultifile/multifile-two-root-files/index.yaml Normal file
View File

@@ -0,0 +1,7 @@
swagger: '2.0'
info:
$ref: ./info/index.yaml
paths:
$ref: ./paths/index.yaml
definitions:
$ref: ./definitions/index.yaml

7
test/data/swaggerMultifile/multifile-two-root-files/index1.yaml Normal file
View File

@@ -0,0 +1,7 @@
swagger: '2.0'
info:
$ref: ./info/index1.yaml
paths:
$ref: ./paths/index.yaml
definitions:
$ref: ./definitions/index.yaml

2
test/data/swaggerMultifile/multifile-two-root-files/info/index.yaml Normal file
View File

@@ -0,0 +1,2 @@
version: 0.0.0
title: Simple API

2
test/data/swaggerMultifile/multifile-two-root-files/info/index1.yaml Normal file
View File

@@ -0,0 +1,2 @@
version: 0.0.0
title: Simple API

8
test/data/swaggerMultifile/multifile-two-root-files/paths/bar.yaml Normal file
View File

@@ -0,0 +1,8 @@
get:
responses:
200:
description: OK
schema:
$ref: '../definitions/User.yaml'
required:
- name

4
test/data/swaggerMultifile/multifile-two-root-files/paths/foo.yaml Normal file
View File

@@ -0,0 +1,4 @@
get:
responses:
200:
description: OK

4
test/data/swaggerMultifile/multifile-two-root-files/paths/index.yaml Normal file
View File

@@ -0,0 +1,4 @@
/foo:
$ref: ./foo.yaml
/bar:
$ref: ./bar.yaml

10
test/data/swaggerMultifile/petstore-separate-yaml/common/Error.yaml Normal file
View File

@@ -0,0 +1,10 @@
type: object
required:
- code
- message
properties:
code:
type: integer
format: int32
message:
type: string

9
test/data/swaggerMultifile/petstore-separate-yaml/spec/NewPet.yaml Normal file
View File

@@ -0,0 +1,9 @@
type: object
allOf:
- $ref: 'Pet.yaml'
- required:
- name
properties:
description:
type: integer
format: int64

12
test/data/swaggerMultifile/petstore-separate-yaml/spec/Pet.yaml Normal file
View File

@@ -0,0 +1,12 @@
type: object
required:
- id
- name
properties:
id:
type: integer
format: int64
name:
type: string
tag:
type: string

16
test/data/swaggerMultifile/petstore-separate-yaml/spec/parameters.yaml Normal file
View File

@@ -0,0 +1,16 @@
tagsParam:
name: tags
in: query
description: tags to filter by
required: false
type: array
collectionFormat: csv
items:
type: string
limitsParam:
name: limit
in: query
description: maximum number of results to return
required: false
type: integer
format: int32

100
test/data/swaggerMultifile/petstore-separate-yaml/spec/swagger.yaml Normal file
View File

@@ -0,0 +1,100 @@
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
email: apiteam@swagger.io
url: http://swagger.io
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
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
Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.
Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.
operationId: findPets
parameters:
- $ref: 'parameters.yaml#/tagsParam'
- $ref: 'parameters.yaml#/limitsParam'
responses:
"200":
description: pet response
schema:
type: array
items:
$ref: 'Pet.yaml'
default:
description: unexpected error
schema:
$ref: '../common/Error.yaml'
post:
description: Creates a new pet in the store. Duplicates are allowed
operationId: addPet
parameters:
- name: pet
in: body
description: Pet to add to the store
required: true
schema:
$ref: 'NewPet.yaml'
responses:
"200":
description: pet response
schema:
$ref: 'Pet.yaml'
default:
description: unexpected error
schema:
$ref: '../common/Error.yaml'
/pets/{id}:
get:
description: Returns a user based on a single ID, if the user does not have access to the pet
operationId: find pet by id
parameters:
- name: id
in: path
description: ID of pet to fetch
required: true
type: integer
format: int64
responses:
"200":
description: pet response
schema:
$ref: 'Pet.yaml'
default:
description: unexpected error
schema:
$ref: '../common/Error.yaml'
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: '../common/Error.yaml'

17
test/data/swaggerMultifile/uberTest/definitions/Activities.yaml Normal file
View File

@@ -0,0 +1,17 @@
properties:
offset:
type: integer
format: int32
description: Position in pagination.
limit:
type: integer
format: int32
description: Number of items to retrieve (100 max).
count:
type: integer
format: int32
description: Total number of items available.
history:
type: array
items:
$ref: '#/definitions/Activity'

4
test/data/swaggerMultifile/uberTest/definitions/Activity.yaml Normal file
View File

@@ -0,0 +1,4 @@
properties:
uuid:
type: string
description: Unique identifier for the activity

8
test/data/swaggerMultifile/uberTest/definitions/Error.yaml Normal file
View File

@@ -0,0 +1,8 @@
properties:
code:
type: integer
format: int32
message:
type: string
fields:
type: string

22
test/data/swaggerMultifile/uberTest/definitions/PriceEstimate.yaml Normal file
View File

@@ -0,0 +1,22 @@
properties:
product_id:
type: string
description: Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles
currency_code:
type: string
description: "[ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code."
display_name:
type: string
description: Display name of product.
estimate:
type: string
description: Formatted string of estimate in local currency of the start location. Estimate could be a range, a single number (flat rate) or "Metered" for TAXI.
low_estimate:
type: number
description: Lower bound of the estimated price.
high_estimate:
type: number
description: Upper bound of the estimated price.
surge_multiplier:
type: number
description: Expected surge multiplier. Surge is active if surge_multiplier is greater than 1. Price estimate already factors in the surge multiplier.

16
test/data/swaggerMultifile/uberTest/definitions/Product.yaml Normal file
View File

@@ -0,0 +1,16 @@
properties:
product_id:
type: string
description: Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles.
description:
type: string
description: Description of product.
display_name:
type: string
description: Display name of product.
capacity:
type: integer
description: Capacity of product. For example, 4 people.
image:
type: string
description: Image URL representing the product.

6
test/data/swaggerMultifile/uberTest/definitions/ProductList.yaml Normal file
View File

@@ -0,0 +1,6 @@
properties:
products:
description: Contains the list of products
type: array
items:
$ref: "#/definitions/Product"

16
test/data/swaggerMultifile/uberTest/definitions/Profile.yaml Normal file
View File

@@ -0,0 +1,16 @@
properties:
first_name:
type: string
description: First name of the Uber user.
last_name:
type: string
description: Last name of the Uber user.
email:
type: string
description: Email address of the Uber user
picture:
type: string
description: Image URL of the Uber user.
promo_code:
type: string
description: Promo code of the Uber user.

186
test/data/swaggerMultifile/uberTest/index.yaml Normal file
View File

@@ -0,0 +1,186 @@
swagger: "2.0"
info:
title: Uber API
description: Move your app forward with the Uber API
version: "1.0.0"
host: api.uber.com
schemes:
- https
basePath: /v1
securityDefinitions:
apikey:
type: apiKey
name: server_token
in: query
produces:
- application/json
paths:
/products:
get:
summary: Product Types
description: The Products endpoint returns information about the Uber products offered at a given location. The response includes the display name and other details about each product, and lists the products in the proper display order.
parameters:
- name: latitude
in: query
description: Latitude component of location.
required: true
type: number
format: double
- name: longitude
in: query
description: Longitude component of location.
required: true
type: number
format: double
security:
- apikey: []
tags:
- Products
responses:
"200":
description: An array of products
schema:
type: array
items:
$ref: '#/definitions/Product'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/estimates/price:
get:
summary: Price Estimates
description: The Price Estimates endpoint returns an estimated price range for each product offered at a given location. The price estimate is provided as a formatted string with the full price range and the localized currency symbol.<br><br>The response also includes low and high estimates, and the [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code for situations requiring currency conversion. When surge is active for a particular product, its surge_multiplier will be greater than 1, but the price estimate already factors in this multiplier.
parameters:
- name: start_latitude
in: query
description: Latitude component of start location.
required: true
type: number
format: double
- name: start_longitude
in: query
description: Longitude component of start location.
required: true
type: number
format: double
- name: end_latitude
in: query
description: Latitude component of end location.
required: true
type: number
format: double
- name: end_longitude
in: query
description: Longitude component of end location.
required: true
type: number
format: double
tags:
- Estimates
responses:
"200":
description: An array of price estimates by product
schema:
type: array
items:
$ref: '#/definitions/PriceEstimate'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/estimates/time:
get:
summary: Time Estimates
description: The Time Estimates endpoint returns ETAs for all products offered at a given location, with the responses expressed as integers in seconds. We recommend that this endpoint be called every minute to provide the most accurate, up-to-date ETAs.
parameters:
- name: start_latitude
in: query
description: Latitude component of start location.
required: true
type: number
format: double
- name: start_longitude
in: query
description: Longitude component of start location.
required: true
type: number
format: double
- name: customer_uuid
in: query
type: string
format: uuid
description: Unique customer identifier to be used for experience customization.
- name: product_id
in: query
type: string
description: Unique identifier representing a specific product for a given latitude & longitude.
tags:
- Estimates
responses:
"200":
description: An array of products
schema:
type: array
items:
$ref: '#/definitions/Product'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/me:
get:
summary: User Profile
description: The User Profile endpoint returns information about the Uber user that has authorized with the application.
tags:
- User
responses:
"200":
description: Profile information for a user
schema:
$ref: '#/definitions/Profile'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/history:
get:
summary: User Activity
description: The User Activity endpoint returns data about a user's lifetime activity with Uber. The response will include pickup locations and times, dropoff locations and times, the distance of past requests, and information about which products were requested.<br><br>The history array in the response will have a maximum length based on the limit parameter. The response value count may exceed limit, therefore subsequent API requests may be necessary.
parameters:
- name: offset
in: query
type: integer
format: int32
description: Offset the list of returned results by this amount. Default is zero.
- name: limit
in: query
type: integer
format: int32
description: Number of items to retrieve. Default is 5, maximum is 100.
tags:
- User
responses:
"200":
description: History information for the given user
schema:
$ref: '#/definitions/Activities'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
definitions:
Product:
$ref: ./definitions/Product.yaml
ProductList:
$ref: ./definitions/ProductList.yaml
PriceEstimate:
$ref: ./definitions/PriceEstimate.yaml
Profile:
$ref: ./definitions/Profile.yaml
Activity:
$ref: ./definitions/Activity.yaml
Activities:
$ref: ./definitions/Activities.yaml
Error:
$ref: ./definitions/Error.yaml

169
test/unit/x20schemapack.test.js
View File

@@ -59,3 +59,172 @@ describe('Convert method', function() {
done();
});
});
describe('Swagger 2.0 schemapack mergeAndValidate method', function() {
it('Should merge correctly the files in folder - petstore separated', function(done) {
let folderPath = path.join(__dirname, '../data/swaggerMultifile/petstore-separate-yaml'),
files = [],
array = [
{ fileName: folderPath + '/spec/swagger.yaml' },
{ fileName: folderPath + '/spec/Pet.yaml' },
{ fileName: folderPath + '/spec/parameters.yaml' },
{ fileName: folderPath + '/spec/NewPet.yaml' },
{ fileName: folderPath + '/common/Error.yaml' }
];
array.forEach((item) => {
files.push({
content: fs.readFileSync(item.fileName, 'utf8'),
fileName: item.fileName
});
});
var schema = new SchemaPack({ type: 'folder', data: files });
schema.mergeAndValidate((err, status) => {
if (err) {
expect.fail(null, null, err);
}
if (status.result) {
schema.convert((error, result) => {
if (error) {
expect.fail(null, null, err);
}
expect(result.result).to.equal(true);
expect(result.output.length).to.equal(1);
expect(result.output[0].type).to.have.equal('collection');
expect(result.output[0].data).to.have.property('info');
expect(result.output[0].data).to.have.property('item');
done();
});
}
else {
expect.fail(null, null, status.reason);
done();
}
});
});
it('Should merge correctly the files in folder - basicExample', function(done) {
let folderPath = path.join(__dirname, '../data/swaggerMultifile/uberTest'),
files = [],
array = [
{ fileName: folderPath + '/index.yaml' },
{ fileName: folderPath + '/definitions/Activities.yaml' },
{ fileName: folderPath + '/definitions/Activity.yaml' },
{ fileName: folderPath + '/definitions/Error.yaml' },
{ fileName: folderPath + '/definitions/Product.yaml' },
{ fileName: folderPath + '/definitions/ProductList.yaml' },
{ fileName: folderPath + '/definitions/Profile.yaml' },
{ fileName: folderPath + '/definitions/PriceEstimate.yaml' }
];
array.forEach((item) => {
files.push({
content: fs.readFileSync(item.fileName, 'utf8'),
fileName: item.fileName
});
});
var schema = new SchemaPack({ type: 'folder', data: files });
schema.mergeAndValidate((err, status) => {
if (err) {
expect.fail(null, null, err);
}
if (status.result) {
schema.convert((error, result) => {
if (error) {
expect.fail(null, null, err);
}
expect(result.result).to.equal(true);
expect(result.output.length).to.equal(1);
expect(result.output[0].type).to.have.equal('collection');
expect(result.output[0].data).to.have.property('info');
expect(result.output[0].data).to.have.property('item');
done();
});
}
else {
expect.fail(null, null, status.reason);
done();
}
});
});
it('Should merge correctly the files in folder - uberTest', function(done) {
let folderPath = path.join(__dirname, '../data/swaggerMultifile/uberTest'),
files = [],
array = [
{ fileName: folderPath + '/index.yaml' },
{ fileName: folderPath + '/definitions/Activities.yaml' },
{ fileName: folderPath + '/definitions/Activity.yaml' },
{ fileName: folderPath + '/definitions/Error.yaml' },
{ fileName: folderPath + '/definitions/Product.yaml' },
{ fileName: folderPath + '/definitions/ProductList.yaml' },
{ fileName: folderPath + '/definitions/Profile.yaml' },
{ fileName: folderPath + '/definitions/PriceEstimate.yaml' }
];
array.forEach((item) => {
files.push({
content: fs.readFileSync(item.fileName, 'utf8'),
fileName: item.fileName
});
});
var schema = new SchemaPack({ type: 'folder', data: files });
schema.mergeAndValidate((err, status) => {
if (err) {
expect.fail(null, null, err);
}
if (status.result) {
schema.convert((error, result) => {
if (error) {
expect.fail(null, null, err);
}
expect(result.result).to.equal(true);
expect(result.output.length).to.equal(1);
expect(result.output[0].type).to.have.equal('collection');
expect(result.output[0].data).to.have.property('info');
expect(result.output[0].data).to.have.property('item');
done();
});
}
else {
expect.fail(null, null, status.reason);
done();
}
});
});
it('Should not merge because therer are 2 root files - multifile-two-root-files', function() {
let folderPath = path.join(__dirname, '../data/swaggerMultifile/multifile-two-root-files'),
files = [],
array = [
{ fileName: folderPath + '/index.yaml' },
{ fileName: folderPath + '/index1.yaml' },
{ fileName: folderPath + '/definitions/index.yaml' },
{ fileName: folderPath + '/definitions/User.yaml' },
{ fileName: folderPath + '/info/index.yaml' },
{ fileName: folderPath + '/info/index1.yaml' },
{ fileName: folderPath + '/paths/bar.yaml' },
{ fileName: folderPath + '/paths/foo.yaml' },
{ fileName: folderPath + '/paths/index.yaml' }
];
array.forEach((item) => {
files.push({
content: fs.readFileSync(item.fileName, 'utf8'),
fileName: item.fileName
});
});
var schema = new SchemaPack({ type: 'folder', data: files });
schema.mergeAndValidate((err, status) => {
if (err) {
expect.fail(null, null, err);
}
expect(status.result).to.equal(false);
expect(status.reason).to.be.equal('More than one root file not supported.');
});
});
});