You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Use FastAPI's built-in OpenAPI generation to produce an OpenAPI 3.0 spec, and convert it to a Postman collection with environment variables for easy API testing.
Requirements
Functional
Configure FastAPI with title "Permit License Platform", version "1.0.0", openapi_url="/openapi.json", docs_url="/docs".
Export OpenAPI spec to docs/openapi.json.
Create a Postman collection v2.1 (docs/postman-collection.json) covering all endpoints: /auth/*, /licenses/*, /licenses/activate, /licenses/heartbeat.
Create a Postman environment file (docs/postman-environment.json) with pre-populated variables: base_url, vendor_id, session_token, license_key.
Document JWT Bearer auth scheme for all protected endpoints.
Include example requests and responses for each endpoint.
Goal
Use FastAPI's built-in OpenAPI generation to produce an OpenAPI 3.0 spec, and convert it to a Postman collection with environment variables for easy API testing.
Requirements
Functional
openapi_url="/openapi.json",docs_url="/docs".docs/openapi.json.docs/postman-collection.json) covering all endpoints:/auth/*,/licenses/*,/licenses/activate,/licenses/heartbeat.docs/postman-environment.json) with pre-populated variables:base_url,vendor_id,session_token,license_key.Technical
python -c "from app.main import app; import json; print(json.dumps(app.openapi()))" > docs/openapi.json.Acceptance Criteria
GET /openapi.jsonreturns a valid OpenAPI 3.0 spec.Dependencies