-
Notifications
You must be signed in to change notification settings - Fork 1.1k
feat(cli): add lb4 openapi-spec command to save openapi spec to json or yaml
#5508
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,47 @@ | ||
| --- | ||
| lang: en | ||
| title: 'OpenAPI spec generator' | ||
| keywords: LoopBack 4.0, LoopBack 4 | ||
| sidebar: lb4_sidebar | ||
| permalink: /doc/en/lb4/OpenAPI-spec-generator.html | ||
| --- | ||
|
|
||
| {% include content/generator-create-app.html lang=page.lang %} | ||
|
|
||
| ### Synopsis | ||
|
|
||
| Saves OpenAPI spec to a json or yaml file. | ||
|
|
||
| ```sh | ||
| lb4 openapi-spec [options] | ||
| ``` | ||
|
|
||
| ### Options | ||
|
|
||
| `--out` or `-o` : File name for the OpenAPI spec | ||
|
|
||
| {% include_relative includes/CLI-std-options.md %} | ||
|
|
||
| ### Interactive Prompts | ||
|
|
||
| The tool will prompt you for: | ||
|
|
||
| - **File name for the OpenAPI spec.** _(outFile)_ If the `--out` had been | ||
| supplied from the command line, the prompt is skipped. | ||
|
|
||
| ### Output | ||
|
|
||
| Once all the prompts have been answered, the CLI will do the following: | ||
|
|
||
| - Start the application without listening on an Http port. | ||
| - Load the OpenAPI spec | ||
| - Save the spec to the file in json or yaml format depending on the extension | ||
|
|
||
| ``` | ||
| lb4 openapi-spec | ||
|
|
||
| ? File name for the OpenAPI spec: dist/openapi.json | ||
| Server is running at undefined | ||
| create dist/openapi.json | ||
| OpenAPI spec is written to dist/openapi.json. | ||
| ``` |
This file contains hidden or 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 hidden or 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 hidden or 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,79 @@ | ||
| // Copyright IBM Corp. 2019,2020. All Rights Reserved. | ||
| // Node module: @loopback/cli | ||
| // This file is licensed under the MIT License. | ||
| // License text available at https://opensource.org/licenses/MIT | ||
|
|
||
| 'use strict'; | ||
|
|
||
| const BaseGenerator = require('../../lib/base-generator'); | ||
| const g = require('../../lib/globalize'); | ||
| const {dump} = require('js-yaml'); | ||
|
|
||
| module.exports = class OpenApiSpecGenerator extends BaseGenerator { | ||
| // Note: arguments and options should be defined in the constructor. | ||
| constructor(args, opts) { | ||
| super(args, opts); | ||
| } | ||
|
|
||
| _setupGenerator() { | ||
| this.option('out', { | ||
| alias: 'o', | ||
| type: String, | ||
| required: false, | ||
| description: g.f('File name for the OpenAPI spec to be written'), | ||
| }); | ||
| return super._setupGenerator(); | ||
| } | ||
|
|
||
| setOptions() { | ||
| return super.setOptions(); | ||
| } | ||
|
|
||
| checkLoopBackProject() { | ||
| if (this.shouldExit()) return; | ||
| return super.checkLoopBackProject(); | ||
| } | ||
|
|
||
| async promptFileName() { | ||
| if (this.shouldExit()) return; | ||
| if (this.options.out) { | ||
| this.outFile = this.options.out; | ||
| return; | ||
| } | ||
| const prompts = [ | ||
| { | ||
| type: 'input', | ||
| name: 'outFile', | ||
| message: g.f('File name for the OpenAPI spec:'), | ||
| default: 'dist/openapi.json', | ||
| }, | ||
| ]; | ||
| const answers = await this.prompt(prompts); | ||
| this.outFile = answers && answers.outFile; | ||
| } | ||
|
|
||
| async saveSpec() { | ||
| if (this.shouldExit()) return; | ||
| this.log('Loading application %s...', this.packageJson.name); | ||
| // Load the `main` function | ||
| const main = require(this.destinationRoot()).main; | ||
| const app = await main({rest: {listenOnStart: false}}); | ||
|
|
||
| // Get the OpenAPI spec | ||
| const spec = await app.restServer.getApiSpec(); | ||
| const outFile = this.outFile || 'dist/openapi.json'; | ||
| const fileName = this.outFile.toLowerCase(); | ||
| if (fileName.endsWith('.yaml') || fileName.endsWith('.yml')) { | ||
| const yaml = dump(spec); | ||
| this.fs.write(outFile, yaml); | ||
| } else { | ||
| this.fs.writeJSON(outFile, spec, null, 2); | ||
| } | ||
| await app.stop(); | ||
| } | ||
|
|
||
| async end() { | ||
| this.log('The OpenAPI spec has been saved to %s.', this.outFile); | ||
| await super.end(); | ||
| } | ||
| }; | ||
This file contains hidden or 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 hidden or 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 hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is it possible to make the default at the root of the project?