개발

[Swagger] Swagger란?

Swagger란? Swagger란 개발한 Rest API를 편리하게 문서화해주고, 이를 통해서 관리 및 제3의 사용자가 편리하게 API를 호출해 보고 테스트할 수 있는 프로젝트이다. Spring boot에서 Swagger를 사용하면, 컨트롤러에 명시된 어노테이션을 해석하여 API문서를 자동으로 만들어준다. Swagger Annotation 사용 예시 build.gradle implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2.0' SwaggerConfig @Configuration @OpenAPIDefinition public class SwaggerConfig { /** * 명세서 정보 */ @Bean public OpenAPI a..

[Hateoas] Hateoas란?

Hateoas? Hypermedia As The Engine Of Application State의 약자로, 기본적인 아이디어는 하이퍼미디어를 애플리케이션의 상태를 관리하기 위한 메커니즘으로 사용한다는 것입니다. Hateoas란 REST API를 사용하는 클라이언트가 전적으로 서버와 동적인 상호작용이 가능하도록 하는 것을 의미합니다. Hateoas는 API를 호출하고 응답하게 되면, 응답 시에 다음 로직에서 필요한 애플리케이션의 API 호출을 담아서 제공하는 규칙입니다. 하이퍼미디어? 음성이나 문자 등 형태가 다른 정보를 동시에 전달하고 표현하는 방법입니다. Hateoas가 나온 이유 Hateoas는 REST API를 잘 설계하기 위해 나온 개념입니다. 잘 설계된 REST API를 구현하기 위한 단계가 ..