{"repo":"marcelojaloto/SwagDoc","free":true,"listed":false,"github":"https://github.com/marcelojaloto/SwagDoc","clone":"git clone https://github.com/marcelojaloto/SwagDoc.git","description":"Create a public documentation REST API using Swagger 2.0 for Delphi.","language":"Pascal","stars":104,"topics":["delphi","swagger","open-api","rest","documetation","api","library","firemonkey","vcl"],"license":"Apache-2.0","category":"api-integrations-sdks","readme_excerpt":"SwagDoc SwagDoc is a Delphi library to generate swagger.json file for Swagger Spec version 2.0. Create a public documentation REST API using Swagger 2.0 for Delphi Language. SwagDoc's only responsibility is to generate the swagger.json file. The swagger.json file is responsible for containing all the documentation for your REST API. This file must be attached to the Swagger UI (User Interface) files. Swagger (Open API) - version 2.0 SwagDoc follows the specification 2.0 because it is more popular in the market and also because it is considered a more stable version to exist the longest. SwagDoc does not yet support the Swagger 3.0 version, but depending on the demand and contributions to the project it may evolve to support spec 3.0. The main prerequisite for working with SwagDoc is to know the Swagger 2.0 specification that can be viewed in the link below. https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md https://swagger.io/docs/specification/2-0/basic-structure/ When creating a Swagger documentation for your REST API you can produce a page like the following example. https://app.swaggerhub.com/apis-docs/swagdoc/sample-api/v1 Json Schema https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#schemaObject http://json-schema.org SwagDoc Speeches https://www.youtube.com/watch?v=9U3HP3B5UT0 (Pt-Br) https://www.youtube.com/watch?v=PhgMQAd8O6c (Pt-Br) Swagger References and Tutorials https://swagger.io/swagger/media/blog/wp-content/uploads/","default_branch":null,"files":null,"tree":[],"storefront":"/r/marcelojaloto","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/marcelojaloto/SwagDoc/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}