From 370dede07a35536e248f57d75768c17d80d22a79 Mon Sep 17 00:00:00 2001 From: Alex Tselegidis Date: Tue, 8 Dec 2020 14:23:35 +0200 Subject: [PATCH] Added the swagger file to the REST API documentation --- docs/rest-api.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/rest-api.md b/docs/rest-api.md index 90ad7eaf..5f47399b 100644 --- a/docs/rest-api.md +++ b/docs/rest-api.md @@ -2,7 +2,15 @@ ## Introduction -Easy!Appointments exposes a flexible REST API that will enables you to handle all the information of your installations through HTTP requests. The API is using JSON as its data transaction format and features many best practices in order to make the resources easily consumable. +Easy!Appointments offers a flexible REST API that will enables you to handle all the information of your installations through HTTP requests. The API is using JSON as its data transaction format and features many best practices in order to make the resources easily consumable. + +### Open API Specification (Swagger File) + +The project has a ready-made [swagger file](https://github.com/alextselegidis/easyappointments/blob/master/swagger.json) you can download and use in order to create your client. + +This file can also be imported into Postman, so that you can quickly get started making requests towards your installation. + +You will find more information about Open API and Swagger on [swagger.io](https://swagger.io). ## Making Requests