Produce an API Reference

This page explains how to create developer-oriented API documentation in Atloria. An API reference gives technical teams a focused place to understand available API behavior and review supporting examples.

Overview

Use the API Reference option in Technical Docs when you need documentation that explains an application’s API-facing functionality for developers, integrators, or technical support teams. This type of document is useful when readers need more context than a short feature description and benefit from examples alongside the reference content.

An API reference works best when it is part of a broader technical documentation set. Atloria’s technical documentation can cover application areas such as frontend, backend, database, API schema, configuration, documentation, and infrastructure. Keep your API reference focused on the API-facing portion of that system so readers can find the information they need quickly.

You can add examples to make the reference more useful. Examples help readers connect the documented API behavior to realistic implementation scenarios.

Prerequisites

Before you begin, make sure you have:

Access to the relevant project in Atloria.
Access to the project’s Technical Docs area.
A clear API topic to document, such as a service integration, endpoint group, request flow, or schema-related feature.
Technical context that you can use to verify the generated reference and its examples.
Examples or scenarios you want developers to see in the finished documentation.

Step-by-Step Instructions

Open the project where you want to create the documentation.
Select Technical Docs from the project workspace.

📷 Screenshot pending: The Technical Docs area within a project workspace.
Open the Technical Docs actions menu.
Select API Reference.
Review the API reference screen before generating content.
Select the available documentation style using the style selector.
Use the generate control to create the API reference content.

📷 Screenshot pending: The API Reference screen showing the style selector and generate control.
Review the generated reference for technical accuracy.
Select Add examples to include supporting examples.
Add an example that demonstrates a realistic developer task.
Select Add code examples when you need examples that show implementation-oriented context.
Review each example to confirm that it supports the API reference rather than repeating it.
Return to Technical Docs when you are ready to work on another document.
Select Export Documentation if you need to share the completed documentation outside Atloria.

Tips and Best Practices

Keep the reference centered on one API topic. A focused reference is easier for developers to scan and maintain than a document that combines unrelated integrations or services.
Use examples deliberately. Select Add examples for contextual scenarios, and use Add code examples when an implementation-oriented illustration will help readers understand the documented behavior.
Organize your supporting material according to the system area it describes. For example, distinguish API schema information from frontend behavior, database details, configuration, and infrastructure context.
Explain relationships that affect how the API is used. For example, readers may need to understand whether a component calls an API, a service implements an API, or a system depends on another service.
Check terminology before sharing the document. Consistent names for components, services, schemas, and API behavior make the reference easier to use across engineering teams.
Use Export Documentation only after reviewing the generated content and examples. Exported documentation should be accurate enough for its intended audience.

Troubleshooting

You cannot find the API Reference option

Open Technical Docs and then open its actions menu. Look for API Reference rather than starting with a general document option such as Create New Document.

Your reference does not include enough practical context

Select Add examples to add scenario-based material. If developers need implementation-focused guidance, select Add code examples and add an example that directly supports the reference topic.

Your documentation covers too many unrelated technical areas

Separate the content by purpose. Keep API-facing material in the API reference, and place unrelated frontend, database, configuration, or infrastructure details in their appropriate technical documentation topics.