{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs-realm.sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["configOptionRequirements"]},"redocly_category":"Realm","type":"markdown"},"seo":{"title":"API documentation","description":"OpenAPI-generated documentation tool with 24k+ stars on Github - make APIs your company's superpower.","siteUrl":"https://redocly.com","image":"/assets/redocly-card.f670aae34a39545a5ea633a540cb3a4a333a1f23bb2ed3c4a1b17a5fbcf0ac85.db81178d.png","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api-documentation","__idx":0},"children":["API documentation"]},{"$$mdtype":"Tag","name":"ConfigOptionRequirements","attributes":{"products":["Redoc","Realm"],"plans":["Pro","Enterprise","Enterprise+"]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Realm supports API description files written according to the most commonly-used specifications:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/content/api-docs/add-asyncapi-docs"},"children":["Add AsyncAPI descriptions"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/content/api-docs/add-graphql-docs"},"children":["Add GraphQL descriptions"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/content/api-docs/add-openapi-docs"},"children":["Add OpenAPI docsdescriptions"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/content/api-docs/add-soap-docs"},"children":["Add SOAP documentation from a WSDL file"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Realm also offers the Mock Server as an alternative to live endpoints and supports extensions for AsyncAPI and OpenAPI description files:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/content/api-docs/configure-mock-server"},"children":["Configure Mock Server"]},": use the Replay console to send calls to your API operations and see sample responses without the need for backend services."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/content/api-docs/asyncapi-extensions"},"children":["AsyncAPI extensions"]},": See the full list of supported AsyncAPI extensions."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/content/api-docs/openapi-extensions"},"children":["OpenAPI extensions"]},": See the full list of supported OpenAPI extensions."]}]}]},"headings":[{"value":"API documentation","id":"api-documentation","depth":1}],"frontmatter":{"products":["Redoc","Realm"],"plans":["Pro","Enterprise","Enterprise+"],"seo":{"title":"API documentation"}},"lastModified":"2026-04-20T09:25:59.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/realm/content/api-docs","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}