[Python] FastAPI를 활용해 API명세서 작성방법(by Swagger, ReDoc)

4. 생성한 router를 app.include_router()를 통해 등록합니다.
   * router.py
    ```Python
    from fastapi import APIRouter, Depends
    from sqlalchemy.orm import Session
    
    from src.api.guest.response_dto import SignUpResponseDto
    from src.api.guest.request_dto import SignUpRequestDto
    from src.api.guest import service as guest_service
    from src.core.database.database import get_db
    from src.core.common.dto import ResponseDTO
    
    router = APIRouter(
    tags=["Guest Manage"],
    )
    
    # 회원가입 관련 정보를 router 내에 입력하여 API 명세 시 활용
    @router.post("/sign-up", response_model=SignUpResponseDto, summary="회원가입", description="회원가입")
    async def sign_up(request_dto: SignUpRequestDto, db: Session = Depends(get_db)): # Depends를 통해 입력되는 내용은 API 명세에 표시되지 않음
        response = guest_service.sign_up(request_dto, db)
        db.commit()
        response["hashed_password"] = None
        return ResponseDTO().of(response)
    ```
   
    * main.py
    ```Python
    from fastapi import FastAPI
    from src.api.guest.router import router as guest_router
   
    app = FastAPI(
        openapi_url="/api", # 실제 API URL
        docs_url="/docs", # Swagger UI URL
        redoc_url="/redoc", # ReDoc URL
    )
   
    app.include_router(guest_router)
    ```
   
    * request_dto.py
    ```Python
    from pydantic import BaseModel
    from typing import Optional
   
    class SignUpRequestDto(BaseModel):
        user_id: str
        password: str
        name: str
        email: str
        phone: Optional[str]=None # Optional을 통해 null을 허용할 것인지 명세하고, None을 통해 필수값 여부를 설정할 수 있음
    ```
   
    * response_dto.py
    ```Python
    from pydantic import BaseModel
    from typing import Optional
   
    class SignUpResponseDto(BaseModel):
        user_id: str
        name: str
        email: str
        phone: Optional[str]
    ```
parameter를 설정할 때 'Optional'을 통해 null을 허용할 것인지 명세하고, '=None'을 통해 필수값(required) 여부를 설정할 수 있습니다. 'request_dto.py' 코드부분을 확인하세요.
<br/><br/>

### API 명세 확인
#### 1. Swagger
docs_url은 기본적으로 base url + /docs로 설정됩니다. 우리가 흔히 아는 Swagger 문서 형식을 제공합니다.<br/>
schema를 통해 필수값에 대한 명세를 확인할 수 있습니다.<br/>
![img.png](../../../assets/img/BackEnd/Python/2024-02-10-FastAPI_SwaggerSettingGuide/docs.png)<br/>
![docs_schema.png](..%2F..%2F..%2Fassets%2Fimg%2F2024-02-10-FastAPI_SwaggerSettingGuide%2Fdocs_schema.png)
<br/><br/><br/><br/>

#### 2. Redoc
redoc_url은 기본적으로 base url + /redoc로 설정됩니다.<br/>
개인적으론 Open API를 만들어 외부 사람들에게 제공할 때 사용하기 좋은 문서 형식이라고 생각됩니다. 여기서는 테스트하기에는 불편하나 한 눈에 어떤 파라미터들이 필수값인지 어떤 응답결과가 나오는지 확인하기에는 좋습니다.<br/>
![redoc.png](..%2F..%2F..%2Fassets%2Fimg%2F2024-02-10-FastAPI_SwaggerSettingGuide%2Fredoc.png)
<br/><br/>

### 추가 설정
저는 잘 사용하진 않지만 Swagger UI 테마 변경도 가능합니다.<br/>
swagger_ui_parameters 매개변수를 사용하여 테마를 설정할 수 있습니다.
```Python
app = FastAPI(
   openapi_url="/api", # 실제 API URL
   docs_url="/docs", # Swagger UI URL
   redoc_url="/redoc", # ReDoc URL
   swagger_ui_parameters={"syntaxHighlight.theme": "obsidian"}, # 테마 설정 - 글씨 색상 변경
)