Skip to content

Commit

Permalink
feat: fix node module path (#70)
Browse files Browse the repository at this point in the history
* feat: node_modules in different directory
* docs: update README
* chore: update dependencies
  • Loading branch information
bfaulk96 authored May 12, 2022
1 parent 39c2cc1 commit edf88a7
Show file tree
Hide file tree
Showing 5 changed files with 2,804 additions and 2,457 deletions.
1 change: 1 addition & 0 deletions .github/workflows/npm-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ jobs:
uses: JS-DevTools/npm-publish@v1
with:
token: ${{ secrets.NPM_TOKEN }}
access: public
- if: steps.publish.outputs.types != 'none'
run: |
echo "Version changed: ${{ steps.publish.outputs.old-version }} => ${{ steps.publish.outputs.version }}"
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ plugins:
plugins: ['serverless-auto-swagger'];
```
**_NOTE_**: This plugin _must_ come before any transform plugins (i.e. `serverless-webpack` or `serverless-plugin-typescript`), and _must_ come before `serverless-offline` if included.

## Usage

This plugin is designed to work with vanilla Serverless Framework. All you need to do is add this plugin to your plugin list and it will generate the swagger file and add the endpoints required. When you deploy your API, your new swagger UI will be available at `https://{your-url-domain}/swagger`.
Expand Down Expand Up @@ -209,4 +211,7 @@ http: {

## with Serverless Offline

In the plugin list, you must list serverless-auto-swagger before the serverless-offline plugin. If you don't you won't get the required endpoints added to your local endpoints.
In the plugin list, you must list `serverless-auto-swagger` before the `serverless-offline` plugin.
If you don't, you won't get the required endpoints added to your local endpoints.

To use serverless v2, you must run serverless-offline in backwards compatibility mode with `serverless offline start`.
Loading

0 comments on commit edf88a7

Please sign in to comment.