Documentation Get Support

Describing an API

API editing

Fig. 1.1a: Describing your API with the web interface.

If you are a developer, you can document your API on Mashape without writing a single line of XML. Add your API and get started.

Describing an API is required to have a nice documentation layout and auto-generate client libraries. Also, without a description the API Profile would look empty and meaningless. The documentation consists of describing what the API does: its authentication scheme, endpoints and models.

An API can be documented through the web editing interface, or by uploading your own XML. For more details on XML documentation, see the XML overview.