Generating documentation for a Datasnap RESTful API

I've been looking for a way to include an auto-generated documentation endpoint to an existing Delphi Datasnap RESTful API.

Can it be done? Are there annotations or external tools I can use? Where would I begin, how would I proceed? If not from within Delphi itself, can I integrate with e.g. Swagger?

It seems somewhat anachronistic to build a RESTful API without offering a documentation endpoint these days...

Any and all information that could help me in the right direction would be greatly appreciated.

Answers


Using Swagger, via YAML has just been added to Delphi through EMS, the latest RESTful API development option in Delphi.

https://delphiaball.co.uk/2016/04/22/swagger-yaml-delphi/

Its based on Attributes that are added to the API end points as they are defined and that in turn creates the YAML to import into Swagger.


Need Your Help

Call asp.net mvc Html Helper within custom html helper with expression parameter

asp.net-mvc lambda expression-trees html-helper

I am trying to write an html helper extension within the asp.net mvc framework.

Why does a .NET 4.0 program produce a system.unauthorizedAccess error on a Windows Server 2012 machine with .NET 4.5 installed?

.net windows .net-4.0 .net-4.5

I'm getting an error that seems to only occur on machines running Windows Server 2012. My application was written for a .NET 4.0 environment. My hypothesis is something in the .NET 4.5 isn't playing