${escape(spec.info.title)}

# Publishing your OpenAPI specification While the OpenAPI spec produced by createOpenAPIFromControllers is fully formed and valid, you may wish to strip away metadata describing the handlers before publishing it. The `stripSOCExtensions` function is provided to do this. ```typescript let docs = createOpenAPIFromControllers(info, types); docs = stripSOCExtensions(docs); ``` This will generate a copy of the documentatin that has all @simply-openapi/controllers extensions removed from it. ## Hosting your spec with swagger As with any OpenAPI document object, you can host it from your own application using `swagger-ui-express` ```typescript import express from "express"; import { serve as swaggerServe, setup as swaggerSetup, } from "swagger-ui-express"; import { createOpenAPIFromControllers, stripSOCExtensions } from "@simply-openapi/controllers"; import { controllers } from "./controllers"; const app = express(); const docs = createOpenAPIFromControllers(..., controllers); ... // This step is optional. const strippedDocs = stripSOCExtensions(docs); app.use("/openapi", swaggerServe, swaggerSetup(strippedDocs)); app.listen(8080); ``` ## Hosting your spec with Stoplight Elements For a more feature packed and polished OpenAPI UI, you may wish to use (Stoplight Elements)\[]. This can be easily integrated into your application with unpkg.com: ```typescript import express, { Router } from "express"; import { createOpenAPIFromControllers, stripSOCExtensions } from "@simply-openapi/controllers"; import { escape } from "html-escaper"; import { controllers } from "./controllers"; const app = express(); const docs = createOpenAPIFromControllers(..., controllers); ... // This step is optional. const strippedDocs = stripSOCExtensions(docs); app.use("/openapi", createDocumentationRouter(strippedDocs)); app.listen(8080); function createDocumentationRouter(spec: OpenAPIObject) { const router = Router(); router.get("/", (req, res) => { res.setHeader("Content-Type", "application/json"); res.send(JSON.stringify(spec, null, 2)); }); router.get("/elements", (req, res) => { res.setHeader("Content-Type", "text/html"); res.send(` ${escape(spec.info.title)}

`); }); } ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://simply-openapi.gitbook.io/simply-openapi-controllers/dev/publishing-openapi-specs.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.