Skip to content

Commit

Permalink
Clarify that REST API documentation is available after starting serve…
Browse files Browse the repository at this point in the history 
…r locally
  • Loading branch information
@CBonnell
CBonnell committed Apr 10, 2024
1 parent 15ca8d8 commit 3a61dab
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -321,8 +321,8 @@ Assuming that Uvicorn has been installed via pipx, the REST API server can be st
uvicorn pkilint.rest:app
```
This command will start the REST API server and listen for incoming requests on TCP/IP port 8000 of the loopback interface. Documentation
is available on the following endpoints:
This command will start the REST API server and listen for incoming requests on TCP/IP port 8000 of the loopback interface.
Once the REST API server has been started, documentation will be available on the following endpoints:
* [Swagger UI](http://127.0.0.1:8000/docs)
* [ReDoc](http://127.0.0.1:8000/redoc)
Expand Down

0 comments on commit 3a61dab

Please sign in to comment.