API documentation

this section explains how to document apis in the ir engine codebase the ir engine uses feathers js https //feathersjs com/ and feathers swagger https //github com/feathersjs ecosystem/feathers swagger to automatically generate openapi documentation from service definitions and schema files the guides below will help you understand the architecture and provide practical steps for creating effective api documentation quick navigation api architecture docid\ ssz271nsxzzsazahwrxpt learn about the api documentation architecture, key components, and generation process documenting endpoints docid 1jbo9mb4njisxg5a2p pa step by step instructions for documenting api endpoints in the ir engine codebase accessing the api documentation the api documentation is served through swagger ui at the /openapi endpoint local development https //localhost 3030/openapi https //localhost 3030/openapi development environment https //api ir engine mt dev theinfinitereality io/openapi https //api ir engine mt dev theinfinitereality io/openapi api development workflow the ir engine uses feathers js for api development, which provides a standardized workflow for creating and documenting api endpoints create schema files to define data structures and available methods implement service logic using hooks for before, after, and error handling add validators and resolvers for data validation and transformation create documentation files with detailed descriptions and examples register the service with the application this workflow ensures consistency across all api endpoints and makes it easier for developers to understand and maintain the codebase additional resources feathers js documentation https //feathersjs com/api/ official feathers js documentation feathers swagger api documentation https //feathersjs ecosystem github io/feathers swagger/#/api complete reference for all available options openapi specification https //swagger io/specification/ the official openapi specification swagger ui https //swagger io/tools/swagger ui/ documentation on the swagger ui interface