https://team-edo.github.io/tags/%EA%B3%84%EC%95%BD-%ED%85%8C%EC%8A%A4%ED%8A%B8/Recent content in 계약 테스트 on 얼쑤 · Team EdoHugoko-krTue, 03 Nov 2026 00:00:00 +0900https://team-edo.github.io/posts/2026/11/generate-private-openapi-contract/Tue, 03 Nov 2026 00:00:00 +0900https://team-edo.github.io/posts/2026/11/generate-private-openapi-contract/<p>백엔드가 호출하는 분석 API의 요청과 응답을 한곳에서 읽을 수 있게 만들고 싶었습니다. 분석 서버는 내부에서만 호출하는 구성이라 운영에 문서 조회 주소를 열 필요는 없었습니다. 또 이미 사용 중인 응답에는 상태마다 다른 필드와 JSON 이름이 있어서, 문서를 붙이는 작업이 기존 직렬화까지 바꾸면 호출자에 영향이 갈 수 있었습니다.</p> <h2 id="스키마-생성과-문서-조회-주소를-분리했다">스키마 생성과 공개 경로 분리</h2> <p>FastAPI의 <code>docs_url</code>, <code>redoc_url</code>, <code>openapi_url</code> 설정은 꺼 둔 채, 앱 객체의 <code>app.openapi()</code>에서 문서를 생성하도록 했습니다. 개발 환경에서 JSON을 파일로 저장해 문서를 읽을 수 있습니다. HTTP 테스트에는 문서 관련 경로 세 곳이 모두 404를 반환하는지도 추가했습니다. <a href="https://fastapi.tiangolo.com/tutorial/metadata/#openapi-url">FastAPI의 문서 URL 설정</a></p>