Skip to content

API endpoint

Gus edited this page Dec 27, 2017 · 13 revisions

Here are the following steps to document a new API endpoint:

  1. Create a new folder in content/api with your endpoint name
  2. Create a code_snippets folder inside the previously created endpoint folder to store all your code examples
  3. Create a _index.md file that contains just the following parameter:
---
title: TITLE OF YOUR ENDPOINT
external_redirect: /api/
---
  1. Create an ENDPOINT.md file that describes your endpoint:
---
title: TITLE OF YOUR ENDPOINT
type: apicontent
order: XX
---

## TITLE OF YOUR ENDPOINT

This is my endpoint description

Note: The order parameter defines where your endpoint entry is displayed in the API navigation bar

Clone this wiki locally