From 3ca677c58493ea5ab813b3c629fc3838f13e4da0 Mon Sep 17 00:00:00 2001 From: Hunter Long Date: Wed, 12 Sep 2018 09:35:30 -0700 Subject: [PATCH] Updated API (markdown) --- API.md | 32 ++++++++++++++++++++++++++------ 1 file changed, 26 insertions(+), 6 deletions(-) diff --git a/API.md b/API.md index 1c37f87..75a30c0 100644 --- a/API.md +++ b/API.md @@ -2,19 +2,39 @@ Statup includes a RESTFUL API so you can view, update, and edit your services wi ## Main Route `/api` -## All Services `/api/services` +## Services + +#### Viewing All Services +- Endpoint: `/api/services` +- Method: `GET` #### Viewing Service - Endpoint: `/api/services/{id}` - Method: `GET` -#### Updating Service POST `/api/services/{id}` +#### Updating Service +- Endpoint: `/api/services/{id}` +- Method: `POST` -#### Deleting Service DELETE `/api/services/{id}` +#### Deleting Service +- Endpoint: `/api/services/{id}` +- Method: `DELETE` -## Single Service `/api/services/{id}` +## Users -## All Users `/api/users` +#### View All Users +- Endpoint: `/api/users` +- Method: `GET` -## Single User `/api/users/{id}` +#### Viewing User +- Endpoint: `/api/users/{id}` +- Method: `GET` + +#### Updating User +- Endpoint: `/api/users/{id}` +- Method: `POST` + +#### Deleting User +- Endpoint: `/api/services/{id}` +- Method: `DELETE`