Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

README.md

FastAPI service example

Generate a minimal FastAPI service with app code, tests, Dockerfile, and environment example.

Use case

Use this when starting a small internal API, service prototype, or baseline for a platform team's Python web service standard.

Command

structkit generate --vars "service_name=DemoAPI,module_name=app,description=A small FastAPI service generated by StructKit." examples/fastapi-service/.struct.yaml ./demo-fastapi-service

Expected output

  • README.md
  • pyproject.toml
  • app/main.py
  • tests/test_health.py
  • Dockerfile
  • .env.example
  • .gitignore

Customization notes

  • Override service_name and module_name to match your repo and Python import name.
  • Extend the generated health endpoint with your real dependency checks.