 import logging

from fastapi import FastAPI
from fastapi.responses import RedirectResponse

logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)

app = FastAPI()


@app.get("/", include_in_schema=False)
def root():
    return RedirectResponse(url="/docs")


@app.get("/list")
def list_entrypoint():
    some_list = ["data1", "data2"]
    return some_list


# Do not remove the main function while updating the app.
if __name__ == "__main__":

About this template

This skeleton is streamlined for creating backend services using FastAPI. It's an excellent choice for building microservices or APIs with minimal frontend requirements.

Introduction to the Backend Server Template

Welcome to the Backend Server Template! This template is designed to help you quickly set up a backend service using FastAPI. It's perfect for creating microservices or APIs with minimal frontend requirements. With this template, you'll have a basic server that can handle GET and POST requests, and you'll be able to deploy it effortlessly on the Lazy platform.

Getting Started

To begin using this template, simply click on "Start with this Template" in the Lazy Builder interface. This will pre-populate the code in the Lazy Builder, so you won't need to copy, paste, or delete any code manually.

Test: Deploying the App

Once you've started with the template, the next step is to deploy your app. Press the "Test" button in the Lazy Builder. This will initiate the deployment process and launch the Lazy CLI. The deployment process is handled entirely by Lazy, so you don't need to worry about installing libraries or setting up your environment.

Using the App

After pressing the "Test" button and deploying your app, Lazy will provide you with a dedicated server link. You can use this link to interact with your API. Additionally, since this template uses FastAPI, you will also be provided with a link to the API documentation at "/docs". This documentation will help you understand the available endpoints and how to interact with them.

Here's a sample request and response for the "/list" endpoint:


GET /list

Sample response:


["data1", "data2"]

For the POST request handler, you can use the following sample request:


POST /your-post-endpoint
Content-Type: application/json

{
    "field": "your data"
}

Sample response:


{
    "message": "Received data: your data"
}

Integrating the App

If you need to integrate this backend service with a frontend or another service, you can use the server link provided by Lazy. For example, if you're building a web application, you can make HTTP requests to the endpoints defined in your FastAPI app from your frontend code.

If you need to handle POST requests, you can integrate the provided POST request handler by sending JSON data to the endpoint you define. Make sure to use the correct URL and set the "Content-Type" header to "application/json".

Remember, this template is just the starting point. You can expand upon it by adding more endpoints, request handlers, and integrating it with other services as needed for your specific use case.

That's it! You're now ready to use the Backend Server Template to build and deploy your backend service with ease. Happy coding!

More templates like this

GPT-4 Exam Generator

This app uses GPT-4 to generate a PDF of a new exam based on an uploaded PDF of a past exam.

Job Search Website

A customisable one-page job search website with a search bar and a search button that displays UI cards of matching jobs. You need to have a (free) account on https://rapidapi.com/ to get the API key required for this to work.