RESTful Rails Development: Building Open Applications and Services by Silvia Puglisi

Author:Silvia Puglisi [Puglisi, Silvia]
Language: eng
Format: epub, pdf
Publisher: O'Reilly Media
Published: 2015-10-07T21:00:00+00:00

Note

Two useful tools available at the time of writing are API Blueprint and APITools.

API Blueprint is a tool for documenting and mocking your APIs at the time of design. It facilitates cooperation among various teams and stakeholders when planning an API product, but can also be used during your whole API lifecycle.

APITools is a hosted proxy service that can be used to wrap API calls and modify their data flows before sending everything to your application.

Documentation

Great documentation is paramount when exposing an API, either to your company or to the public on the Internet. Well-written documentation takes a lot of effort and time, but it is the key element to excite developers about your product. If developers are going to invest time and money in applications that will use your service, they need to be convinced that your API can be an important and useful component for their projects.

API management systems can expose a list of tools to create quality documentation right from your code or your method definitions. Also, they can be linked directly to your code base, so every time you push a change your documentation can be immediately updated.

The alternative once again is to use configurable open source libraries for the same purpose. You won’t have to reinvent the wheel, but you will be responsible for updating your documentation if something changes in your code base, and for keeping your dependencies up to date.

Download

Copyright Disclaimer:
This site does not store any files on its server. We only index and link to content provided by other sites. Please contact the content providers to delete copyright contents if any and email us, we'll remove relevant links or contents immediately.