FastAPI on Antoine Boucherhttps://antoineboucher.info/CV/blog/tags/fastapi/Recent content in FastAPI on Antoine BoucherHugoen-usSat, 01 Jun 2024 10:00:00 -0400ChatGPT plugin with FastAPI — implementation outlinehttps://antoineboucher.info/CV/blog/posts/fastapi-chatgpt-plugin-overview/Sat, 01 Jun 2024 10:00:00 -0400https://antoineboucher.info/CV/blog/posts/fastapi-chatgpt-plugin-overview/<p>OpenAI-style <strong>plugins</strong> expose an HTTP API described by an <strong>OpenAPI</strong> document so ChatGPT can call your tools safely. <strong>FastAPI</strong> generates OpenAPI for you, which fits this model well.</p> <h2 id="1-define-the-api-in-fastapi">1. Define the API in FastAPI</h2> <ul> <li>Routes return <strong>JSON</strong> with stable shapes (no ambiguous free text where structure matters).</li> <li>Add <strong>summaries and descriptions</strong> on paths and fields — they help the model choose the right tool.</li> </ul> <h2 id="2-publish-openapijson">2. Publish <code>openapi.json</code></h2> <ul> <li>FastAPI serves <strong><code>/openapi.json</code></strong> by default; the plugin manifest points at this URL (or a static copy you version).</li> <li>Keep schemas <strong>tight</strong>: enums, required fields, and examples reduce bad calls.</li> </ul> <h2 id="3-plugin-manifest">3. Plugin manifest</h2> <ul> <li>Host <strong><code>ai-plugin.json</code></strong> (or the format required by the current OpenAI developer docs) over <strong>HTTPS</strong>.</li> <li>Manifest references your API base URL and OpenAPI location.</li> </ul> <h2 id="4-auth">4. Auth</h2> <ul> <li>Prefer <strong>OAuth</strong> or <strong>API keys</strong> as documented for your integration; never commit secrets.</li> <li>Validate tokens inside FastAPI dependencies or middleware.</li> </ul> <h2 id="5-deploy">5. Deploy</h2> <ul> <li><strong>HTTPS</strong> endpoint reachable from OpenAI’s servers.</li> <li>Logging and <strong>idempotency</strong> for side-effecting routes.</li> </ul> <h2 id="6-test-manually">6. Test manually</h2> <ul> <li>Call routes with <code>curl</code> or HTTPie using the same payloads the model will send.</li> <li>Iterate on descriptions and constraints before exposing wide traffic.</li> </ul> <blockquote> <p>Details change with OpenAI’s platform updates — always follow the latest <strong>plugin / tools / actions</strong> documentation when wiring production apps.</p>