Nice & Clean Layout
Turnapi provides you with clean & clear, fresh, user-friendly design out-of-the box.
We've researched top 50 visited API resources and aggregated best practices in one place.
Another great thing is that you don’t have to start from ground. We are perfectly aware that all REST-full API have something in common. For example:
- “Getting Started” page - is a welcome page to your API
- “API Status” page shows known issues, important announcements
- “Code Samples” page with links to different libraries and samples of usage
- “API References” page with GET, POST, DELETE methods and params definition
We will help you to define carcass of your future documentation.
You no longer need to write documentation in text editor first and then translate it into HTML code.
Turnapi WIKI editor is a text-to-HTML conversion tool for web writers that is based on markdown standards.
Markdown allows you to write using an easy-to-read, easy-to-write plain text format, and then convert it to structurally valid XHTML.
Its major goal is making it as readable as possible.
Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions.
Why not to start writing API documentation along with writing actual code and thus reduce timeline and costs?
Competent developers will have no difficulty describing methods using accustomed markdown syntax because it’s really easy
and moreover becomes so popular. By the end, all you need is to provide API documentation path on SVN, Git or Mercurial
and all formatting, basic styles will be automatically applied.
Moreover, we will synchronize any changes, you can use different VC systems with
different API versions and at anytime - continue manual support of each.
Our Menu & Tree managers enable you to manage web site top menu and reference tree very easily.
You can add, remove, restore pages from the basket and change their order using drag and drop.
We did everything possible so that developers could find what they are looking for.
First of all, it is Ajax auto-suggest/auto-complete that adds a pop-down menu of suggested values to a search field.
The user can click directly on a suggestion to enter it into the field, navigate the list using the up and down arrow keys
or select a value using the tab key. The values for the suggestion list are provided by intellectual search engine.
The last one can search by API resources and other user comments with an ability to Sort and Filter.
Being an active member of the Agile team is crucial to a writer’s success as well as engineering.
You can apply all benefits of teamwork to writing API documentation.
You and your team are able to change the same files.
Any corrections will be saved as a separate revision to conduct a complete history of changes.
You always have a possibility to go to any revision and make urgent changes at any moment.
Completed revision can be published to end-users.
In addition, you can create and maintain multiple versions of the documentation, which is extremely important for an API.
Would you like to improve your API documentation constantly? Now it is super easy.
Turnapi allows users to leave comments on the methods and any piece of information you want. All these options are easy configurable.
API Management team will be notified of every new comment left by users for quick response.
In addition, any member of the team as well as any user can subscribe to the RSS feed.
This is the easiest and low-pressure way to monitor any changes.