Create API to Starlette app

[horseinthesky]

Hello.
I couldn't find the answer may be because the question is not very specific.

I have a working Starlette app:

import datetime
import typesystem
import uvicorn

from starlette.applications import Starlette
from starlette.routing import Route, Mount
from starlette.staticfiles import StaticFiles
from starlette.templating import Jinja2Templates

from netbox_helper import NetboxInterface
from vlantoggler import Toggler

forms = typesystem.Jinja2Forms(package="bootstrap4")
templates = Jinja2Templates(directory="templates")
statics = StaticFiles(directory="statics", packages=["bootstrap4"])

togglings = []


class VTSchema(typesystem.Schema):
    tor = typesystem.String(title='ToR name', max_length=50)
    interface = typesystem.String(title='Interface name', max_length=15)
    state = typesystem.Choice(
        title='Desired state',
        choices=[
            ('prod', 'prod'),
            ('setup', 'setup'),
        ],
    )

    def __repr__(self):
        return f"Interface {self.interface} on {self.tor} was switched to {self.state.upper()} state at {self.toggle_time}"


def render(request, form=forms.Form(VTSchema), vl_status=None):
    context = {'request': request, 'form': form, 'togglings': togglings[-5:], 'vl_status': vl_status}
    return templates.TemplateResponse('index.html', context)


async def toggle(request):
    <do stuff>
    return render(request)


app = Starlette(
    debug=True,
    routes=[
        Route('/', toggle, methods=['GET', 'POST']),
        Mount('/statics', statics, name='static'),
    ],
)

if __name__ == "__main__":
    uvicorn.run(app, loop='uvloop', log_level='debug')

And want to add API to my app with the same functionality using FastAPI but I cannot get how to combine two app objects.
Could you provide some example pls?

[aviramha]

Starlette inherits from FastAPI, so you should be able to just replace:

from starlette.applications import Starlette

with:

from fastapi import FastAPI

and then just replace Starlette with FastAPI in your app.

[horseinthesky]

Great. This works:

app = FastAPI(
    routes=[
        Route('/', home, methods=['GET', 'POST']),
        Mount('/statics', statics, name='static'),
    ],
)

Can I add

@app.post('/api')
async def api(device: APIModel):
  <do stuff>

@app.get('/api')
async def api(device: APIModel):
  <do stuff>

If it is possible to do API routing like this?:

app = FastAPI(
    routes=[
        Route('/', home, methods=['GET', 'POST']),
        APIGet('/api', api),
        APIPost('/api', api),
        Mount('/statics', statics, name='static'),
    ],
)

or

app = FastAPI(
    routes=[
        Route('/', home, methods=['GET', 'POST']),
        API('/api', api, methods=['GET', 'POST']),
        Mount('/statics', statics, name='static'),
    ],
)

async def api(request, device: APIModel):
    if request.method == 'POST':
    <do stuff>

[tiangolo]

Yes, you can use that style, with APIRoute (instead of APIPost or API).

Check an example here in this comment: #687 (comment)

[luckydonald]

This needs to be documented better.

[horseinthesky]

Yes, you can use that style, with APIRoute (instead of APIPost or API).

Check an example here in this comment: #687 (comment)

Great. Didn't find it in the documentation. Thank you.
If I do both GET and POST

APIRoute(
    "/items{item_id}", read_item, methods=["GET", "POST"], response_class=JSONResponse
),

is it possible to check the method from the fucntion?

[phy25]

is it possible to check the method from the fucntion?

request.method https://www.starlette.io/requests/#method

[horseinthesky]

is it possible to check the method from the fucntion?

request.method starlette.io/requests/#method

I mean check the method with APIRoute.

This doesn't work:

async def api(request, device: APIModel):
    if request.post == 'POST':
        <do stuff>
    elif request.method == 'GET':
        <do other stuff>


app = FastAPI(
    routes=[
        Route('/', home, methods=['GET', 'POST']),
        APIRoute('/api', api, methods=['GET', 'POST']),
        Mount('/statics', statics, name='static'),
    ],
)

I get:

{"detail":[{"loc":["query","request"],"msg":"field required","type":"value_error.missing"}]}

[horseinthesky]

So is it possible to do different stuff depending on the request method with APIRoute?

[horseinthesky]

Read that this is wrong design pattern. Doing mounting different applications now.

[tiangolo]

Thanks for reporting back and closing the issue @horseinthesky 👍