Skip to content

Commit

Permalink
Merge pull request #46 from alanb-sony/patch-1
Browse files Browse the repository at this point in the history
Update Readme.md
  • Loading branch information
cdimascio authored Oct 15, 2020
2 parents 61c9b56 + 746b89b commit a8b1c82
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,13 +261,13 @@ paths:
**Q**: How do I modify the example API and make it my own?
**A**: There are two key files that enable you to customize and describe your API:
1. `server/routes.js` - This references the implementation of all of your routes. Add as many routes as you like and point each route your express handler functions.
1. `server/routes.ts` - This references the implementation of all of your routes. Add as many routes as you like and point each route your express handler functions.
2. `server/common/api.yaml` - This file contains your [OpenAPI spec](https://swagger.io/specification/). Describe your API here. It's recommended that you to declare any and all validation logic in this YAML. `express-no-stress-typescript` uses [express-openapi-validator](https://github.com/cdimascio/express-openapi-validator) to automatically handle all API validation based on what you've defined in the spec.

**Q**: I previously generated an app, but I want to change the API root. How do I do this?

**A**: You need to make to small changes
1. Modify `server/routes.js`
1. Modify `server/routes.ts`
```javascript
// Change your original path e.g. /api/v1/examples, to:
app.use('/api/v2/examples', examplesRouter);
Expand Down
4 changes: 2 additions & 2 deletions app/templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ npm run test
## How do I modify the example API and make it my own?

There are two key files:
1. `server/routes.js` - This references the implementation of all of your routes. Add as many routes as you like and point each route your express handler functions.
1. `server/routes.ts` - This references the implementation of all of your routes. Add as many routes as you like and point each route your express handler functions.
2. `server/common/api.yaml` - This file contains your [OpenAPI spec](https://swagger.io/specification/). Describe your API here. It's recommended that you to declare any and all validation logic in this YAML. `express-no-stress-typescript` uses [express-openapi-validator](https://github.com/cdimascio/express-openapi-validator) to automatically handle all API validation based on what you've defined in the spec.

## Install Dependencies
Expand Down Expand Up @@ -71,7 +71,7 @@ npm run test:debug
```

## Try It
* Open you're browser to [http://localhost:3000](http://localhost:3000)
* Open your browser to [http://localhost:3000](http://localhost:3000)
* Invoke the `/examples` endpoint
```shell
curl http://localhost:3000<%= apiRoot %>/examples
Expand Down

0 comments on commit a8b1c82

Please sign in to comment.