REST API Documentation

Tools used: Visual Studio Code, GitHub, Swagger

Purpose: This mock API Documentation was created for programmers who want to learn how to use BMW's API.

Identify User and Use Cases

I identified the audience in order to structure the document effectively according to their needs.

Lverage Tools

I used open source tools like Swagger to turn API definitions into interactive documentation. Use collaborative tools like GitHub.

Be Consistent

I stuck with existing standards for documenting APIs. Use POST, DELETE, PUT, and GET according to established conventions.

Incorporate Examples

I used examples for every call, parameter, and response to help users understand information in the least amount of time.