API Documentation

1 post

Coding workstation

Writing API Documentation for Developers

Who is the API Documentation Audience? When you write API documentation, you write for the API developer. When it comes to API documentation, developers focus on two things: What requests look like (you want the server to understand it) What responses look like (you want to make sense of the data) Supposed that my endpoint is located here: https://hostname:port/base/movies Simple Request I want to get a list of movies, so how do I get this result? GET /movies Simple Response […]