728x90 반응형 Swagger2 [Redoc] SpringRestDocs로 Redoc으로 변환하기 Spring 문서화 도구 Spring에서 많이 사용되는 문서화 도구에는 RestDocs, Swagger가 있습니다. RestDocs : 테스트 케이스를 통과할때만 문서가 만들어지도록 강제하여 코드의 검증이 어느정도 가능하다. 문서 추가시 asciidoc 문서 수정 필요 Swagger : OpenAPI로 화려한 UI와 API 테스트가 가능한 문서 작성이 가능하다. Swager-UI 사용시 단점 : 코드에 어노테이션으로 도배되어 가독성이 떨어짐 Redoc : OpenAPI 스펙의 파일을 읽어 깔끔한 UI로 문서화가 가능하며, Swagger와 마찬가지로 OpenAPI 로 동작하기 때문에 함께 이용하기에 부담이없다. 참고사이트 RestDocs에서 OpenApi 스펙 추출 [https://taetaetae.git.. 2023. 4. 11. [Swagger] Swagger Editor 설치 Swagger Editor란 Swaager는 OpenAPI를 정의하는 툴 OpenAPI (OpenAPI Specification - OAS) : RESTful API 규격에 맞게 API 스펙을 정의한 방식 Open API는 개방 API로 띄어쓰기의 차이지만 용어의 차이가 있다. Swagger Editor는 OpenAPI를 작성해 Swagger로 보여주기 위한 툴 그 밖에도 Swaager UI, Swagger Codegen 등이 Swager의 도구로 사용된다. https://editor.swagger.io/ 사이트에서 온라인으로 작성할 수도 있고, 도커로 설치하여 로컬에서 작업할 수도 있다. Docker 설치 docker pull swaggerapi/swagger-editor docker run -d -p.. 2023. 4. 6. 이전 1 다음 LIST
