OpenAPI는 무엇입니까?

소개

엔지니어 인턴을 하고 약 3개월이 지나고 있습니다.
요전날의 업무로 OpenAPI에 처음 접했으므로, OpenAPI란 무엇인가, 사용법등을 보답할 수 있도록 메모해 가고 싶습니다.

원래 OpenAPI란?

한 사이트에 이렇게 쓰여졌습니다.

OpenAPI는, 소위 「Web API」의 사양을 형식적으로 기술하기 위한 포맷

좀 더 씹으면 "백엔드가 아직 끝나지 않은(태스크가 미완)시에 프런트엔드만으로 구현(거동)을 확인하기 위한 것"입니다.

마치 뒤에서 데이터가 반환되는 것처럼 보일 수 있습니다. 사실은 openapi.yaml에 골고루 쓰여져 있지만 ...

OpenAPI를 괴롭히는 방법

전제 조건
localhost 번호는 docker-compose.yml에 작성되었으므로 참조
Swagger UI이지만 docker 이미지를 사용하고 있습니다.

1 env 파일을 열고 NEXT_PUBLIC_API_SERVER_URL=https:~ 을 NEXT_PUBLIC_API_SERVER_URL= http://localhost:9003 로 변경합니다.

2 http://localhost:3000 에서 검색하면 OpenAPI의 example로 만들어진 것만으로 구성된 것이 표시된다.

3 직접 openapi.yaml에 기술하는 것이 아니라 Swagger UI라는 소프트웨어를 사용. ( http://localhost:9002/ 을 열고 편집합니다. (9002는 swagger-editor의 포트 번호 사용))
덧붙여서, localhost : 9001에서는 기술은 할 수 없지만 swagger UI를 보는 것만 가능

4 Swagger editor에서 편집한 내용을 복사하여 openapi.yaml에 붙여넣고 version을 하나 올립니다. (편집 할 때마다 버전 업그레이드가 필요합니다)version: "0.4.9" だったら version: "0.4.10"に変更
5 http://localhost:3000/ 를 열고 유효성 검사 > Network > 1을 차례로 확인합니다.

data를 열고 안에 데이터가 들어 있으면 완벽!

마지막으로

openAPI를 만지면 로직 부분도 배웠습니다. 그러나, 이해가 따라잡지 않았기 때문에 전제 지식으로서 DDD, 클린 아키텍쳐의 이해가 필요하다고 느꼈습니다.