Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/egomobile/swagger-ui-cli
A standalone CLI application, serving Swagger UIs via a HTTP server.
https://github.com/egomobile/swagger-ui-cli
cli json nodejs openapi rest-api swagger toml typescript yaml
Last synced: about 2 months ago
JSON representation
A standalone CLI application, serving Swagger UIs via a HTTP server.
- Host: GitHub
- URL: https://github.com/egomobile/swagger-ui-cli
- Owner: egomobile
- License: gpl-3.0
- Created: 2021-05-31T10:56:17.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-31T13:37:29.000Z (about 1 year ago)
- Last Synced: 2024-05-02T09:43:11.638Z (8 months ago)
- Topics: cli, json, nodejs, openapi, rest-api, swagger, toml, typescript, yaml
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/swagger-ui-cli
- Size: 685 KB
- Stars: 9
- Watchers: 1
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/swagger-ui-cli)
# swagger-ui-cli
A standalone CLI application, serving [Swagger UIs](https://swagger.io/tools/swagger-ui/) via a HTTP server.
## Install
You can install it globally:
```bash
npm install -g swagger-ui-cli
```
Or for your project, from where your `package.json` file is stored:
```bash
npm install --save-dev swagger-ui-cli
```
## Usage
```
$ swagger-ui --help
A standalone CLI application, serving Swagger UIs via a HTTP server.
Usage
$ swagger-ui [options]
Options
--allow-scripts Allow the execution of scripts. Default: (false)
--do-not-open Do not open local URL after server has been started. Default: (false)
--no-json Do not provide JSON data as download. Default: (false)
--no-toml Do not provide TOML data as download. Default: (false)
--no-yaml Do not provide YAML data as download. Default: (false)
--port, -p The custom TCP port. Default: 8080
The source document as local file path or URL. Supports JSON, YAML and TOML.
Examples
Starts a new server instance on port 8080 for a local file
$ swagger-ui swaggerFile.yaml
Run a Node.js script (also from a remote host), which builds the document
$ swagger-ui buildDoc.js --allow-scripts
Using port 8181 and load document from HTTP server without providing TOML as download
$ swagger-ui https://raw.githubusercontent.com/apache/superset/1.4.0rc2/docs/src/resources/openapi.json --no-toml --port=8181
Do not open browser, after server has been started and use "foo" as username and "bar" as password
$ swagger-ui https://example.com/my-api.toml --do-not-open --username=foo --password=bar
```
### Scripts
If you have a complex logic to build an [OpenAPI](https://www.openapis.org/) document, maybe it is separated into multiply sources and parts, you can execute JavaScript code, which runs in the same Node.js environment as the application.
In that case, you have to start the application with `--allow-scripts` flag.
Example:
```javascript
// use any Node.js you want
const fs = require("fs");
// you are also able to access 3rd party modules
// if a 'node_modules' folder is available
const axios = require("axios");
// make use of local Node modules
// which exports functions that loads
// parts of the document, e.g.
const myModule = require("/path/to/my/module.js");
const info = await fs.promises.readFile(
"/path/to/apiDocumentInfo.json",
"utf8"
);
// maybe load data from remote sources
const paths = (await axios.get("https://strapi.example.com/paths")).data;
const components = await myModule.loadComponents();
// put all parts together ...
const doc = {
openapi: "3.0.0",
info,
servers: [
{
url: "http://petstore.swagger.io/api",
},
],
paths,
components,
};
// ... and return the document
return doc;
```
## Download
You can download documents via browser or HTTP client directly. Examples:
- http://localhost:8080/json ([JSON](https://en.wikipedia.org/wiki/JSON))
- http://localhost:8080/toml ([TOML](https://en.wikipedia.org/wiki/TOML))
- http://localhost:8080/yaml ([YAML](https://en.wikipedia.org/wiki/YAML))
## Contributors
- [malagege](https://github.com/malagege)
- [Geno Roupsky](https://github.com/groupsky)
## License
[GPL 3.0](./LICENSE)