Explore a scalable, split OpenAPI architecture designed for enterprise-grade API documentation. Each component is modular, reusable, and perfectly organized.
đ
đ
Petstore APIs
Rootâē
đ¯
Client Specific Documents
A directory of where your client specific documents are stored.âē
đĻProduct StoreThe folder where you specify your Custom product docs.âē
đStore.yamlThe custom generated API doc based on your client requirements.
đmain.yamlThe spec from which the client specific document can be created.
đĻProduct UserThe folder where you specify your Custom product docs.âē
đUser.yamlThe custom generated API doc based on your client requirements.
đmain.yamlThe spec from which the client specific document can be created.
đ§Š
components
Reusable OpenAPI componentsâē
đĄexamplesâē
đCatToyProduct.yaml
đDogFoodProduct.yaml
đ...
âī¸parametersâē
đCategory.yaml
đInStock.yaml
đ...
đī¸
schemas
Data modelsâē
đAddress.yaml
đCart.yaml
đŖī¸
paths
API endpointsâē
đproducts_{productId}.yaml
đusers.yaml
đ
...
each file is one path
âšī¸
info.yaml
API title, version, description
âšī¸
servers.yaml
BaseURL details
â
openapi.yaml
The source file that will be split into multiple files.Main