-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
6 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,10 @@ | ||
# Bookstore Management API | ||
|
||
With the Bookstore Management API, you can build custom inventory and order management apps for bookstores via three endpoints: | ||
I designed this mock API and supporting documentation site for [Specialization in API Documentation](https://www.pce.uw.edu/specializations/api-documentation), which is offered by the University of Washington. | ||
|
||
* `/books` - Books in the store inventory. | ||
* `/customers` - Customers, who purchase books using orders. | ||
* `/orders` - Orders from customers, made up of books. | ||
In the scenario I came up with, developers use this API to build custom bookstore applications. | ||
|
||
[Documentation](https://btbristow.github.io/book-tracker-api/) is in progress. To learn more about this API, contact your sales representative. | ||
The Bookstore Management API is only designed to run with [JSON Server](https://www.npmjs.com/package/json-server). | ||
|
||
|
||
My API docs are [located here](https://btbristow.github.io/bookstore-management-api/). |