If you are looking to document your API, we have a super contract API documentation writer coming available in the next two weeks. Contact us if you’d like to learn more.
Tag: api
GDS publishes its new design for technical documentation
The Government Digital Service has been working on establishing a standard design for its technical (i.e. developer) documentation. This content is for systems architects, developers and users of the GOV.UK platforms and APIs. You can see an example at: GOV.UK Platform as a Service Cherryleaf was given a preview of the new design a few months… Read more »
Policies and procedures as an API
Here’s a trend that didn’t make our list of predictions for 2017 – having company policies and procedures accessible via an Application Programming Interface (API). API is a term used to describe mechanisms that allow an application to access data or functionality provided by another application, system or service. For example, if your policies and procedures were… Read more »
Microsoft publishes its REST API Design Guidelines
Microsoft has published its REST API Design Guidelines to the API community. According to Gareth Jones, Principal API Architect, who announced its release: “The effort got started from hearing two key points of feedback from customers: It should be easier to get started with Microsoft APIs – Developers wanted to be able to run the curl tool… Read more »
API documentation design patterns
One of the current developments in technical communication is the development of a common way to present API documentation. At present, there are a number of different design patterns that organisations are using, but, as with many things, there seems to be a desire to establish a de facto standard. One part of this has… Read more »