[API] API와 RestAPI
·
Back end/API
API식당을 예로 손님은 Client, 점원은 API, 주방장은 Server로 생각할 수 있습니다. 손님이 점원에게 음식을 주문하고, 점원이 그 주문을 주방장에게 전달하며, 주방장이 음식을 준비한 다음, 점원이 그 음식을 다시 손님에게 전달하는 과정을 보여줍니다.손님 (Client): 서비스를 이용하려는 사용자점원 (API): 사용자의 요청을 받아서 내부 시스템(서버)으로 전달하고, 그 결과를 사용자에게 반환하는 역할주방장 (Server): 요청을 처리하고 결과를 반환하는 내부 시스템+------------------+ +------------------+ +------------------+| 손님 | ---주문서---> ..
Swagger2 사용하여 RESTful API 문서 자동화하기 (Feat.egovframework 전자정부프레임워크)
·
Back end/Spring Project
Swagger란? 개발한 API를 사용자에게 제공하도록 하는 Web API 문서화 도구로 쓰입니다. Swagger를 사용하면, @어노테이션과 코드 설정을 통해 간단하게 API를 문서화 및 테스트가 가능한 UI를 제공하여 별도의 문서를 만들 필요 없이 Restful서비스의 문서작성과 유지보수에 대한 효율성을 높일 수 있습니다. 전자정부프레임워크(egovframework)에서 Swagger 적용하기 구글링을해보면 전부 스프링부트에서 Swagger를 적용하는 방법이어서, 전자정부를 사용하는 저는 Swagger를 구현하는데 많은 난관이 있었습니다. 그럼, 전자정부프레임워크에서 적용하는 방법을 알아보겠습니다. 1. pom.xml에 Maven dependency 추가 ... io.springfox springfox..