Sample of README.md for API Projects

README.md

API

Live Sample

API

• POST /api/authenticate
• GET /api/sample
• POST /api/sample
• GET /api/sample/:id
• DELETE /api/sample/:id
• UPDATE /api/sample/:id

POST /authenticate

Resource URL

http://127.0.0.1:80/api/authenticate

Parameters

Parameter	Description
email required	End-user email. Example Values: admin@gmail.com
password required	End-user password. Example Values: secret

Example Request

Request URL:

POST http://104.236.68.60:8080/api/authenticate?email=admin&password=secret

Response:

{
	"status": 200,
	"message": "OK",
	"data": [
		{
			"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImlzcyI6Imh0dHA6XC9cL2dub3ZhZXMuY29tLmJyOjgwODBcL2FwaVwvYXV0aGVudGljYXRlIiwiaWF0IjoxNDc3MjU5NDM0LCJleHAiOjE0NzcyNjMwMzQsIm5iZiI6MTQ3NzI1OTQzNCwianRpIjoiOGU0YzRhNGVlYTY1ZjdjMzI3MjlhNmY5YTM1NmRhMTUifQ.64o7tAQ5A95Aqefh1Y3SqBN4CakeVToPqQNQynjNB7E"
		}
	]
}