Skip to content

Commit 53b9f42

Browse files
authored
Merge pull request #36 from NHSDigital/APM-6127-update-README
APM-6127 update README for open API gen
2 parents c88d0c7 + ef88123 commit 53b9f42

1 file changed

Lines changed: 5 additions & 7 deletions

File tree

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,17 +64,15 @@ Each API and team is unique. We encourage you to use a `test/` folder in the roo
6464

6565
* [**openapi-yaml-mode**](https://github.com/esc-emacs/openapi-yaml-mode) provides syntax highlighting, completion, and path help
6666

67-
### Speccy
6867

69-
> [Speccy](http://speccy.io/) *A handy toolkit for OpenAPI, with a linter to enforce quality rules, documentation rendering, and resolution.*
68+
### OpenAPI Generator
7069

71-
Speccy does the lifting for the following npm scripts:
70+
> [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator-cli) *OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec*
7271
73-
* `test` -- Lints the definition
74-
* `publish` -- Outputs the specification as a **single file** into the `build/` directory
75-
* `serve` -- Serves a preview of the specification in human-readable format
72+
OpenAPI Generator does the lifting for the following npm scripts:
7673

77-
(Workflow detailed in a [post](https://developerjack.com/blog/2018/maintaining-large-design-first-api-specs/) on the *developerjack* blog.)
74+
* `lint` -- Lints the definition
75+
* `publish` -- Outputs the specification as a **single file** into the `dist/` directory
7876

7977
:bulb: The `publish` command is useful when uploading to Apigee which requires the spec as a single file.
8078

0 commit comments

Comments
 (0)