Expose a defined API contract
Create up to 3 simple REST endpoints to read, create, update or delete a resource according to agreed behaviour.
Python and FastAPI service
Build a documented Python REST API with FastAPI
This page helps you determine whether the service fits your project’s endpoints, data, business rules and integration constraints before continuing on ComeUp.
View the service on ComeUpWhen this service is a good fit
The service is intended for an API whose contract, inputs, outputs and rules can be defined before development begins.
Add a backend to an application
Provide an existing web, mobile or business application with structured HTTP routes when the expected exchanges are already identified.
Prepare a documented integration
Validate data with Pydantic, handle HTTP errors and make the contract available through Swagger/OpenAPI documentation.
What you receive
The base service remains aligned with the commercial scope currently published on ComeUp.
- The complete source code for a FastAPI application with up to 3 simple REST endpoints
- Data validation, HTTP error handling and Swagger/OpenAPI documentation
- A README with installation and startup instructions, essential tests and one round of corrections after delivery
What to prepare
A precise contract makes it possible to verify the scope and integration constraints before work begins.
- The expected endpoints, their HTTP methods and their purpose
- Anonymised examples of the input and output data, together with business rules and errors to handle
- The existing application context, technical environment and relevant integration constraints
What requires a separate scope
The base service focuses on a small documented API. Features that change the architecture, security or operation must be confirmed separately on ComeUp.
Not included in the base service
- A PostgreSQL or MySQL database, SQLAlchemy models, Alembic migrations and database-backed CRUD routes require the corresponding option
- JWT authentication and roles require the corresponding option; OAuth and SSO are not included
- Docker, additional tests and deployment require the corresponding option; hosting fees and maintenance are not included
- Designing a complete web or mobile interface is outside this API service