DFD(Documentation-First Development) with FastAPI

Introduce

About this project

Requirements

• You need to prepare some environments to run and test appliations.

Programming Language

• Python needs over 3.12
• Go needs over 1.20

Package Management

• Use Poetry for managing Python packages.

Table of Contents

1. Code generator through Open API for client developers

1-1. openapi-typescript-codegen

• Introduce how client developers generate client codes through Open API specification on 01-code-generator-through-open-api-for-client-developers.

2. A Conventional method of documentation

2-1. Comments

• Introduce a conventional method to write a comment-based documentation on 02-introduce-a-conventional-method-to-write-a-comment-based-documentation.

2-2. Metaprogramming

• Introduce metaprogramming with Open API generator in Go lanauge on 03-introduce-metaprogramming-with-open-api-generator-in-go-language.

3. Code-based documentation

3-1. FastAPI and Pydantic

• Introduce FastAPI and Pydantic with a code-based documentation on 04-introduce-fastapi-and-pydantic-with-a-code-based-documentation.

4. A way of good documentation

4-1. Efficientcy

• Introduce how to write a good code-based documentation on 05-introduce-how-to-write-a-good-code-based-documentation.

4-2. Security

• Introduce how to make a code-based documentation secured on 06-introduce-how-to-make-a-code-based-documentation-secured.

Reference

Conventional ways to build a documenation

• Notion
• Postman

Code generator through Open API

• openapi-typescript-codegen
• oapi-codegen

Open API generator in Flask

• flasgger
• apispec

FastAPI and Pydantic

• fastapi
• Sub application pattern with mount method in FastAPI
• Open API docs in FastAPI
• Declare request example data in FastAPI
• pydantic
• computed_fields decorator in Pydantic
• json_schema_extra field in Pydantic