Skip to content

Commit

Permalink
Update readme to include summary of api endpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
MitchellMcKenna committed Aug 18, 2017
1 parent af2a155 commit 45eb617
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,24 @@

Example of a simple product sales API.

API docs: [docs.productsalesapi.apiary.io](http://docs.productsalesapi.apiary.io).

* Built using [Laravel](https://laravel.com).
* Follows [JSON API](http://jsonapi.org) spec.

## API Endpoints

```
GET|POST /products
GET /products/top-sellers
GET|PATCH|DELETE /products/1
GET|POST /orders
GET|PATCH|DELETE /orders/1
```

### API Docs
API docs: [http://docs.productsalesapi.apiary.io](http://docs.productsalesapi.apiary.io).

The API docs include more detailed examples of the endpoints, query params, input and and response payloads. Written using [Blueprint](https://apiblueprint.org), they can be updated by editing /apiary.apib.

## Requirements

* [Composer](https://getcomposer.org/doc/00-intro.md#globally)
Expand Down Expand Up @@ -40,12 +53,6 @@ Server welcome page now available at [127.0.0.1:8000](http://127.0.0.1:8000).

API available at /api (eg. [127.0.0.1:8000/api/products](http://127.0.0.1:8000/api/products)).

## API Docs

API docs of endpoints available at [docs.productsalesapi.apiary.io](http://docs.productsalesapi.apiary.io).

Written using [Blueprint](https://apiblueprint.org), they can be updated by editing /apiary.apib.

## Make API Calls Using Postman
You can make API calls using [Postman](https://www.getpostman.com/). In Postman:

Expand Down

0 comments on commit 45eb617

Please sign in to comment.