This page explains how to create and review API documentation in Atloria’s Technical Docs area. Clear API documentation helps your technical teams understand available endpoints, required inputs, returned outputs, and possible errors before they integrate with an application.
Overview
Atloria organizes generated technical content by project. When you open Technical Docs for a project, you can review the available documentation and generate API reference content from the project’s analyzed application structure.
API documentation is most useful after a project has been parsed successfully. Atloria’s analysis progresses through categories such as frontend, backend, database, API schema, configuration, documentation, and infrastructure. API details are available when the project contains identifiable API schema or backend information.
The generated API reference is intended to help you document:
- Available API endpoints and their purpose
- Request inputs, including parameters and body data when detected
- Response outputs and returned data structures
- Error conditions and response details when available in the analyzed project
- Relationships between API implementations and the components or services that call them
📷 Screenshot pending: The Technical Docs area for a selected project, showing available documentation categories and API reference content.
Prerequisites
Before you begin, make sure you have:
- Access to the relevant Atloria project.
- A project that has completed parsing successfully, or completed with warnings that you have reviewed.
- API-related source material in the project, such as backend implementations or API schema definitions.
- Permission to view the project’s Technical Docs.
- A selected project; if no project is selected, Atloria displays Select a project to view documents.
Step-by-Step Instructions
-
Open Documents from the main application navigation.
-
Select the project that contains the API you want to document.
-
Open Technical Docs for the selected project.
-
Confirm that the project analysis has completed before generating documentation.
-
Review any parse warnings before continuing if the analysis completed with warnings.
-
Select the API reference area in the Technical Docs navigation or documentation tree.
-
Choose the documentation style using the available style selector.
-
Click the generation button in the API reference reader to create or refresh the API documentation.
-
Review each documented endpoint to confirm that its purpose and available request inputs are understandable.
-
Review the output section for each endpoint to confirm that returned data is represented correctly.
-
Review the documented errors for each endpoint to identify expected failure conditions and error responses.
-
Use the documentation tree to move between related backend, API schema, and implementation information.
-
Click Export Documentation when you are ready to share the completed documentation outside Atloria.
📷 Screenshot pending: The API reference reader showing generated endpoint documentation, request inputs, outputs, errors, style selection, and the generation control.
Tips and Best Practices
-
Generate API documentation after parsing is complete. API reference quality depends on Atloria being able to identify backend and API schema information during project analysis.
-
Review documentation when parsing completes with warnings. A warning does not necessarily prevent documentation from being created, but it can mean some source information was unavailable or could not be fully interpreted.
-
Use the documentation tree to validate context. An endpoint may be connected to services, database queries, models, or user-interface components. Reviewing those relationships can help you explain why an endpoint exists and how it is used.
-
Use a consistent documentation style for the project. The style selector helps keep generated reference material consistent when you generate documentation for multiple API areas.
-
Regenerate the API reference after major application changes. If endpoints, input fields, response structures, or error handling change in the project, refresh the documentation so readers are not relying on outdated information.
-
Review generated content before exporting it. Confirm that endpoint names, inputs, outputs, and errors are meaningful to the intended technical audience.
-
Keep API documentation focused on what consumers need to use the API. Describe the expected request information, successful output, and known error behavior for each endpoint.
Related Pages
- Technical Docs — Open and manage technical documentation for a project.
- Documents — Find project documentation and return to the document list.
- Export Documentation — Export completed documentation for sharing or review.
- User Guides — Create end-user documentation for user-facing workflows.
- Create Manually — Add documentation manually when generated material needs additional explanation.
Troubleshooting
You see “Select a project to view documents”
Select a project before opening Technical Docs. Atloria cannot display project-specific API documentation until a project is selected.
API documentation is incomplete or does not include expected endpoints
Check whether the project parsing completed successfully. If parsing completed with warnings, review the affected areas and generate the API reference again after the project analysis has been updated.
The generated documentation does not reflect recent API changes
Return to Technical Docs, open the API reference reader, and use the generation button again. Then review the refreshed endpoint inputs, outputs, and errors before selecting Export Documentation.
Was this page helpful?