Delphi/delphimvcframework
1
0
Fork 0
mirror of https://github.com/danieleteti/delphimvcframework.git synced 2024-11-16 16:25:54 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
57da1259d8
delphimvcframework/lib/swagdoc/Deploy
History
Daniele Teti 3ccd6b6122 DMVCFramework package includes SwaggerDoc code.
2019-10-24 15:35:39 +02:00
..
favicon-16x16.png Added SwagDoc 2019-09-25 14:54:04 +02:00
favicon-32x32.png Added SwagDoc 2019-09-25 14:54:04 +02:00
index.html Added SwagDoc 2019-09-25 14:54:04 +02:00
oauth2-redirect.html Added SwagDoc 2019-09-25 14:54:04 +02:00
readme.txt Added SwagDoc 2019-09-25 14:54:04 +02:00
swagger-ui-bundle.js Added SwagDoc 2019-09-25 14:54:04 +02:00
swagger-ui-standalone-preset.js Added SwagDoc 2019-09-25 14:54:04 +02:00
swagger-ui.css Added SwagDoc 2019-09-25 14:54:04 +02:00
swagger-ui.js Added SwagDoc 2019-09-25 14:54:04 +02:00
swagger.json DMVCFramework package includes SwaggerDoc code. 2019-10-24 15:35:39 +02:00

readme.txt 

When creating a Swagger documentation for your REST API you can produce a page like the following example.

![image](https://user-images.githubusercontent.com/20048296/39936694-a4d9ac9a-5523-11e8-8161-98d0e396eb6f.png)
http://petstore.swagger.io


For you to produce a page containing a Swagger documentation you need the Swagger UI distribution files.

These files you can find in the github swagger-api / swagger-ui repository.

https://github.com/swagger-api/swagger-ui/tree/master/dist

![image](https://user-images.githubusercontent.com/20048296/39937130-2925f868-5525-11e8-921d-c9ff0f59fefd.png)


First you need to download the swagger user interface files and generate the swagger.json file. You then need to change the index.html file to indicate the relative path of the location where the swagger.json file is located on your web server that is hosting the swagger user interface files.

See an example below.

![image](https://user-images.githubusercontent.com/20048296/39946376-49ad0df0-5544-11e8-8a5c-0980f5e6c257.png)