Skip to content

Commit 1799315

Browse files
authored
Update README.md
1 parent 8711241 commit 1799315

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,22 @@
11
# Northwind API
2+
## Swagger URL
3+
https://data-northwind.indigo.design/swagger/index.html
4+
5+
## Highlights
6+
- Textbook REST example.
7+
- POST accepts the whole entity, even the "id", although it gets ignored and returns the created entity
8+
- PUT accepts the whole entity, even the "id"
9+
- DELETE methods need to map the id, like id=customerId
10+
- DELETE methods return a copy of the deleted entity
11+
- In order to create a Bearer token, use the POST -> `/Auth/Register` with the example request body:
12+
```
13+
{
14+
"email": "[email protected]",
15+
"password": "test",
16+
"confirmedPassword": "test"
17+
}
18+
```
19+
20+
This will return a token in the format:
21+
22+
`eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJJZCI6Im....`

0 commit comments

Comments
 (0)