Skip to content

Commit d132325

Browse files
docs: explain authentication on README (#576)
1 parent 28e261d commit d132325

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@ Try it online at <https://demo.api-platform.com>.
2121

2222
You can now go to https://localhost
2323

24+
Authentication and usage:
25+
26+
- Admin: the credentials are shown on https://localhost/admin You can create a Book with `https://openlibrary.org/books/OL2055137M.json` as value for *Book Reference*
27+
- API:
28+
- endpoints without the `/admin` prefix are public and can be called without further step
29+
- endpoints with the `/admin` prefix require an authentication: open https://localhost/docs then check the “openid” option under “Scopes” and click on “Authorize”. If you are not yet logged in on the API then log in with the credentials, and finally click on “Close”. You can now perform authenticated requests through the API, like listing books on `GET /admin/books`
30+
2431
## What Can I Find In This Demo?
2532

2633
This demo application contains several things you may be interested:

0 commit comments

Comments
 (0)