Resolve server URLs and extract hosts from OpenAPI 3.x and Swagger specifications.
MIT License
openapi-url-resolver is a lightweight NPM package that provides a simple and efficient way to resolve server URLs from OpenAPI specifications. It also removes protocols from the resolved URLs and allows you to easily extract host information from OpenAPI definitions. This package is ideal for developers working with APIs that conform to the OpenAPI 3.x specification and need to extract server information to make API calls. Check out the blog post for more detailsHow to resolve server URLs containing variables in OpenAPI 3.x definitions?
You can install openapi-url-resolver
via NPM:
npm install openapi-url-resolver
To use openapi-url-resolver
, you need to pass an OpenAPI 3.x specification object to the resolve()
function. This function will return an array of resolved server URLs:
const openapiUrlResolver = require('openapi-url-resolver')
const spec = {
openapi: '3.0.0',
servers: [
{
url: 'https://{username}.gigantic-server.com:{port}/{basePath}',
description: 'The production API server',
variables: {
username: {
default: 'demo',
description: 'this value is assigned by the service provider, in this example `gigantic-server.com`'
},
port: {
enum: ['8443', '443'],
default: '8443'
},
basePath: {
default: 'v2'
}
}
}
]
}
const hosts = openapiUrlResolver.resolve(spec)
/*
[
'demo.gigantic-server.com:8443/v2',
'demo.gigantic-server.com:443/v2'
]
*/
console.log(hosts)
Pass false
as second parameter to get the server URLs with protocols.
const serverUrls = openapiUrlResolver.resolve(spec, false)
/*
[
'https://demo.gigantic-server.com:8443/v2',
'https://demo.gigantic-server.com:443/v2'
]
*/
console.log(serverUrls)
You can test using the below command or write your own tests using the OpenAPI specifications examples.
npm test
The below are the known limitations, and they are not handled to keep it a lightweight and focused module to just extract the server information.
Contributions to openapi-url-resolver
are most welcome!
If you find a bug or want to suggest a new feature, please open an issue on the GitHub repository. If you want to contribute code, please fork the repository, make your changes, and submit a pull request. Your contributions and feedback are most welcome!
openapi-url-resolver is authored by @vinitshahdeo and released under the MIT License.
If you find this package useful, please consider starring this repository on GitHub to show your appreciation. You can stay connected with me on Twitter@vinit_shahdeo.
Thank you for your support!