Is there support for x-codeSamples

[marcodelmoral]

Hello

ReDoc supports some extra function, including code samples. Is there any way to implement this within fastapi?

[rsby]

It is possible to add code samples:

openapi_schema = get_openapi(title=app_title, version="0.0.1", routes=app.routes,)
openapi_schema['paths']['/users']['get']['x-codeSamples'] = [{
    'lang': 'Javascript',
    'source': 'fetch("http://127.0.0.1:8000/users")'
}]

For my case, I have an /examples dir in my project. This files are named in a format to match the path and the HTTP method, for example:

envs-get.js
envs-{env_id}-get.js
envs-{env_id}-users-get.js
envs-{env_id}-users-{user_id}-get.js

And then I add these all to the doc with the following:

import logging
import os
import pathlib

logger = logging.getLogger()

lang_extension_lookup = {
    '.py': 'Python',
    '.js': 'Javascript',
    '.java': 'Java',
}


def add_examples(openapi_schema: dict, examples_dir):
    for filename in os.listdir(examples_dir):
        if isinstance(examples_dir, pathlib.PurePath):
            file_path = pathlib.Path(examples_dir / filename)
        else:
            file_path = pathlib.Path(examples_dir + '/' + filename) 
        if file_path.suffix in lang_extension_lookup:
            parts = file_path.stem.split('-')
            if len(parts) >= 2:
                route_method_schema = openapi_schema['paths']['/' + '/'.join(parts[:-1])][parts[-1]]
                code_samples = route_method_schema.get('x-codeSamples', [])
                code_samples.append({
                    'lang': lang_extension_lookup[file_path.suffix],
                    'source': file_path.read_text()
                })
                route_method_schema['x-codeSamples'] = code_samples
            else:
                logger.warning('Example filename does not meet format of {route_path}_{http_method}.{lang_extensions}')
        else:
            logger.warning(f'Not a valid example file: {filename}')

[alteralt]

Use the openapi_extra parameter
For example:

import fastapi

app = fastapi.FastAPI()

@app.post(
    "/test",
    openapi_extra={"x-codeSamples": [{"lang": "Python", "source": "print('FastAPI!')", "label": "Python"}]}
)
async def test():
    pass