Matt Ledger
Matt Ledger
June 13, 2018

[New feature] Add always-available documentation to your APIs

There's no sense creating an API that no one else can figure out how to use. That's why Thriftly Developer now allows you to document the APIs you create from your existing Windows applications.

Thriftly API documentation example

Here's how you can ensure that other developers, working inside or outside your company, understand what your Thriftly APIs do and what values they return.

Easily add documentation to your Thriftly APIs
To document your API, you simply update your existing Thriftly-enabled service to include a new piece of Thriftly metadata (the DocumentationAttribute). Then, you add the function, parameter, and return-value specific documentation you want to see at your API's service URL.

Below, you can see an example of Thriftly API documentation formatted within a .NET/C# application, but also note that you can add documentation for APIs built from Java, DataFlex, and Delphi applications as well.

Thriftly API documentation in .NET/C# application

For more detailed instructions, refer to the new Adding and Accessing API Documentation section of the Thriftly docs.

By adding documentation to your Thriftly APIs, you make it even easier for others to connect with your existing applications - allowing you to re-use, rather than rewrite, your existing code as you build or connect with new apps.

We hope you're as excited about this feature as we are, and if you have any questions, be sure to reach out to us or leave a comment below.