Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kalinchernev committed Feb 26, 2021
1 parent 1ae0406 commit 8873370
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 15 deletions.
21 changes: 17 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
## Change Log

### v6.0.5 (2021/02/15 15:50 +00:00)
### v6.0.7 (2021/02/26 14:32 +00:00)

- [#250](https://github.com/Surnet/swagger-jsdoc/pull/250) Update FIRST-STEPS.md (#250) (@azizkale)
- [da152ea](https://github.com/Surnet/swagger-jsdoc/commit/da152eaf81656b77f49628005225ef7e0f647c9e) Update docs (@kalinchernev)

### v6.0.6 (2021/02/16 09:01 +00:00)

- [32540d1](https://github.com/Surnet/swagger-jsdoc/commit/32540d1f36fc286c72d260f4690465744ba08ca0) docs version bump (@kalinchernev)
- [12a4e6d](https://github.com/Surnet/swagger-jsdoc/commit/12a4e6d9cdcbd2c9d7497413425ac9dedffcdbcc) Update landing page readme (@kalinchernev)
- [c65d659](https://github.com/Surnet/swagger-jsdoc/commit/c65d659b6df554b1e0cc2552d4340cdfdc27f4c3) Update issue templates (@kalinchernev)

### v6.0.5 (2021/02/15 15:52 +00:00)

- [05bc5a9](https://github.com/Surnet/swagger-jsdoc/commit/05bc5a91b8dc008243c74109ffd557ef5ed9d8a8) bump (@kalinchernev)
- [a56522f](https://github.com/Surnet/swagger-jsdoc/commit/a56522f11560727fc7327f7c0e9c083d8517dd2e) changelog (@kalinchernev)
- [#247](https://github.com/Surnet/swagger-jsdoc/pull/247) feat: support cjs and update docs (#247) (@kalinchernev)

### v6.0.3 (2021/02/15 08:40 +00:00)
Expand Down Expand Up @@ -59,7 +72,7 @@

### v5.0.1 (2020/11/08 08:22 +00:00)

- [#224](https://github.com/Surnet/swagger-jsdoc/pull/224) Update README.md (#224) (@zeevosec)
- [#224](https://github.com/Surnet/swagger-jsdoc/pull/224) Update README.md (#224) (@zeevo)

### v5.0.0 (2020/10/28 15:36 +00:00)

Expand Down Expand Up @@ -498,8 +511,8 @@
- [e38c3b9](https://github.com/Surnet/swagger-jsdoc/commit/e38c3b947071c85ee73c16113035ab164dd065a6) update version (@fliptoo)
- [14ccf0b](https://github.com/Surnet/swagger-jsdoc/commit/14ccf0b7effc2379f1b7adbe440b70c858f23aee) fixed swagger option (@fliptoo)
- [#6](https://github.com/Surnet/swagger-jsdoc/pull/6) Merge pull request #6 from slajax/master (@slajax)
- [9623f70](https://github.com/Surnet/swagger-jsdoc/commit/9623f704aa0a76824357314de81c2c02c5889549) added basePath to readme (@slajax)
- [1b4f3d6](https://github.com/Surnet/swagger-jsdoc/commit/1b4f3d6dfb2ba93e9d5e673083db2dbe9e186bad) basePath should still be able to be set so it can be passed to swagger.js (@slajax)
- [9623f70](https://github.com/Surnet/swagger-jsdoc/commit/9623f704aa0a76824357314de81c2c02c5889549) added basePath to readme (@kc-dot-io)
- [1b4f3d6](https://github.com/Surnet/swagger-jsdoc/commit/1b4f3d6dfb2ba93e9d5e673083db2dbe9e186bad) basePath should still be able to be set so it can be passed to swagger.js (@kc-dot-io)
- [e97684d](https://github.com/Surnet/swagger-jsdoc/commit/e97684da334d7fd7414e87505de39c6e8336553f) Fixes #4 (@fliptoo)
- [9e89f97](https://github.com/Surnet/swagger-jsdoc/commit/9e89f977d831650ae5392a3a89277d4e43a5ecae) Update Example (@fliptoo)
- [4581d7a](https://github.com/Surnet/swagger-jsdoc/commit/4581d7a8f0fe05c10a1b7323f586b9091cade748) Fixes #4 (@fliptoo)
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,11 @@ The resulting `openapiSpecification` will be a [swagger tools](https://swagger.i

![swagger-jsdoc example screenshot](./docs/screenshot.png)

## Node.js version requirements, CommonJS and ESM
## System requirements

`swagger-jsdoc` 6.x requires Node.js 12.x and above. When using the CLI, the library will attempt to load the definition file in several formats: `.js`, `.cjs`, `.yaml` (or `.yml`) and `.json`.
- Node.js 12.x or higher

The example above follows the CommonJS format, which will work when you do not have `"type": "module"` in your `package.json`.

However, if you're using ESM and have `"type": "module"`, then please change the extension to `.cjs`.

If you need `swagger-jsdoc` to be fully ESM, check out the [7.x](https://github.com/Surnet/swagger-jsdoc/tree/v7) which is currently in a RC version.
You are viewing `swagger-jsdoc` v6 which is published in CommonJS module system.

## Installation

Expand All @@ -76,4 +72,8 @@ yarn add swagger-jsdoc

## Documentation

Detailed documentation is available within [`/docs`](https://github.com/Surnet/swagger-jsdoc/tree/master/docs/README.md) folder.
Click on the version you are using for further details:

- [7.x](https://github.com/Surnet/swagger-jsdoc/tree/v7/docs)
- [6.x](https://github.com/Surnet/swagger-jsdoc/tree/v6/docs)
- [5.x](https://github.com/Surnet/swagger-jsdoc/tree/v5)
3 changes: 1 addition & 2 deletions docs/FIRST-STEPS.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,14 +87,13 @@ The following is an acceptable reference to information from `x-amazon-apigatewa

Additional materials to inspire you:

- [How to implement and use Swagger in Node.js](https://js.plainenglish.io/how-to-implement-and-use-swagger-in-nodejs-d0b95e765245) - 24/02/2021
- [Document your Javascript code with JSDoc](https://dev.to/paulasantamaria/document-your-javascript-code-with-jsdoc-2fbf) - 20/08/2019
- [Swagger: Time to document that Express API you built!](https://levelup.gitconnected.com/swagger-time-to-document-that-express-api-you-built-9b8faaeae563) - 25/05/2019
[Express API with autogenerated OpenAPI doc through Swagger](https://www.acuriousanimal.com/blog/2018/10/20/express-swagger-doc) - 20/10/2018
- [Express에 Swagger 붙이기](https://gongzza.github.io/javascript/nodejs/swagger-node-express/) - 18/07/2018
- [Swaggerize your API Documentation](http://imaginativethinking.ca/swaggerize-your-api-documentation/) - 01/06/2018
- [Swagger and NodeJS](https://mherman.org/blog/swagger-and-nodejs/) 20/11/2017
- [Agile documentation for your API-driven project](https://kalinchernev.github.io/agile-documentation-api-driven-project) - 21/01/2017
- [How to implement and use Swagger in Node.js](https://js.plainenglish.io/how-to-implement-and-use-swagger-in-nodejs-d0b95e765245) - 24/02/2021

Suggestions for extending this helpful list are welcome! [Submit your article](https://github.com/Surnet/swagger-jsdoc/issues/new)

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "swagger-jsdoc",
"description": "Generates swagger doc based on JSDoc",
"version": "6.0.6",
"version": "6.0.7",
"engines": {
"node": ">=12.0.0"
},
Expand Down

0 comments on commit 8873370

Please sign in to comment.