Swagger [Nest] Swagger API 적용 2번의 프로젝트 동안 Gitbook을 사용해서 API 명세들을 관리했다. 1. API 명세 내용이 변경 될 때마다 웹페이지에서 하나하나 변경 해줘야한다. Gitbook은 거의 API 명세를 관리하는 메모장의 기능이기에, 설계단계가 끝나고 작성할 때는 참 간편하지만 프로젝트 중반에 API가 변경된다고 귀찮은 일이 아닐 수 없다. 물론 변경이 일어나지 않도록 설계를 잘 ~ 짜는 게 중요하지만 그... SwaggerNestJSNestJS Spring Boot) Swagger UI Spring으로 Rest API를 개발한 이후 클라이언트 개발자에게 매번 문서로 정리하여 공유할 때, API에 대한 수정이 발생할 때마다 문서도 수정하여 다시 공유해야 하는 점이 번거롭고, 사실 문서 정리부터 번거롭다. 이때 Swagger를 사용하게 되면 API 문서 자동화로 따로 문서로 정리할 필요도 없을 뿐만 아니라 UI에서 직접 API를 테스트해볼 수 있기 때문에 편리하다. 즉, 서버로... Swagger스프링부트Swagger NestJS - 2 Swagger로 API 문서 작성하기 이번에는 API문서를 보여주는 툴인 Swagger를 Nest에 적용시켜보고자한다. Nest 공식 문서에 가면 swagger 세팅 법까지 전부 나와있는데, 그걸 우선 똑같이 쓴다. 후에 프로젝트의 main.ts에 들어가 swagger를 사용하겠다고 선언을 해주면 된다. title, description, version은 추후에 확인할 수 있으니 보고 수정하면 된다. 이것이 url에서 endpo... NestJSAPI문서expressSwaggerAPI문서 Open API(Swagger) 공통 Header 생성 SwaggerJavaJava 드디어 마주친 작심삼일? 그럼 내일은 또 다시 작심일일 시작하자! (Code camp FE 6기) 이렇게 바로바로 치면서 도출값을 볼 수 있기때문에, 오류가 있는지 없는지 바로바로 확인할수 있다 ! - http Request, Response 텍스트/하이퍼텍스트(HTML)의 길 - HTTP - API 프론트엔드는 해당 API에 저장을 요청할 수 있다. (백엔드의 API는 사실 하나의 함수라고 한다 SaveProfile()과 같은...) 백엔드에서 어떠한 형식으로 API를 만들어 주는가! ... graphqlPlayground프론트엔드algorithmjsonSwagger202203REST코드캠프6기CRUDpostmanAPI202203 [TIL] NestJS 공부 38일차 OpenAPI란 RESTfulAPI를 설명하는데 사용 언어에 구애받지 않고 정의하는 형식입니다. Swagger를 이용해서 API를 설명합시다. 설치 만약 fastify를 사용한다면 아래의 명령어를 대신해주면 되지만 저는 fastify보단 전에 한번 써본 모듈로 해보겠습니다. 스웨거 사용 위 코드는 Swagger를 초기화시켜주는 기본 문구들입니다. Swagger에서 기본인 Title, Desc... SwaggerSwagger API 문서 웹에 만들기 실무에서 API를 만들다가 엑셀로 API문서를 정리하는게 귀찮았으며 로컬에서 바로 확인 할 수 있게 만들기 위해 Swagger 를 사용해 보았다. request를 주면 response 받는 형식을 알아보기 쉽게 만들어져 있어서 만족하며 사용했다. xml 의존성 추가 gradle 의존성 추가 maven, gradle 상황에 맞는 의존성을 추가해준다. 그다음 swagger를 등록해야 하는데 패키... SwaggerJavaAPIAPI [Spring] 나만의 게시판 만들기 5 - Swagger 설정 Swagger를 통해 REST API로 개발한 내용의 문서화가 가능하며, 간단한 테스팅 작업을 UI로 표현 가능하기 때문에 사용했습니다. Shoooooooot! 스프링의 gradle에 의존성을 추가하여 swagger를 사용할 수 있도록 합니다. @Configuration : 설정 파일을 가르키는 스프링 애노테이션입니다. 이를 통해, 스프링 빈 컨테이너에서 해당 클래스를 설정 클래스로 간주합니... SwaggerSpringSpring [Swagger] Spring Boot, Gradle 환경에서 Swagger 적용하기 build.gradle 최신 버전인 Swagger 3.x 버전을 적용 Swagger 2.x 버전보다 간단하게 springfox-boot-starter 하나 추가로 필요한 모든 라이브러리 포함 가능 SwaggerConfig.java configuration 파일 SwaggerConfig.java 추가 Docket: Swagger 설정의 핵심이 되는 Bean useDefaultResponseMe... SwaggergradleSpringbootSpringboot Springboot 통합 Swagger 작업 단계 Swagger는 RESTful 스타일의 웹 서비스를 생성, 설명, 호출, 시각화하는 데 사용되는 규범적이고 완전한 프레임워크입니다.전체 목표는 클라이언트와 파일 시스템을 서버로 똑같은 속도로 업데이트하는 것이다.역할: 인터페이스의 문서가 온라인으로 자동으로 생성됩니다 기능 테스트.. 1단계:pom을 설정합니다.xml 2단계: IDEA 실행 Reimport All Maven Projects 3... Swaggerspringboot Laavel에서 OpenAPI/Swagger를 사용한 Feature 테스트 개발된 API가 OpenAPI/Swagger와 같은지 테스트할 수 있다면 좋겠습니다. 이렇게 멋진 기사가 나왔는데 코드 양이 많아져서 좀 간단하게 할 수 있을까 해서요. 이런 좋은 점을 발견해서 사용해 봤어요. PHP 8.1.4 이번에 시도한 소스 코드 OpenAPI 준비 openapi.yaml Stoplight의 미리보기에서 이런 느낌입니다. 와 같이 hotmeteor/spectator에 ... LaravelPHPSwagger테스트OpenAPItech Swashbuckle.AspNetCore v5.0.0 이후 처리 옵션의 유형이 변경되었습니다. 만약 마이크로소프트의 공식 참고를 추구한다면 정보는 업데이트될 것이다 Swashbuckle 및 ASP.NET Core의 개요 Swashbuckle.5.0.0 미만 Startup.cs Swashbuckle.AspNetCore version 5.0.0 이상 Startup.cs 참고 자료 Why Swashbuckle.aspnet.core.swagger not being recognized - st... dotnetcoreSwaggeraspdotnetcoreswashbuckletech
[Nest] Swagger API 적용 2번의 프로젝트 동안 Gitbook을 사용해서 API 명세들을 관리했다. 1. API 명세 내용이 변경 될 때마다 웹페이지에서 하나하나 변경 해줘야한다. Gitbook은 거의 API 명세를 관리하는 메모장의 기능이기에, 설계단계가 끝나고 작성할 때는 참 간편하지만 프로젝트 중반에 API가 변경된다고 귀찮은 일이 아닐 수 없다. 물론 변경이 일어나지 않도록 설계를 잘 ~ 짜는 게 중요하지만 그... SwaggerNestJSNestJS Spring Boot) Swagger UI Spring으로 Rest API를 개발한 이후 클라이언트 개발자에게 매번 문서로 정리하여 공유할 때, API에 대한 수정이 발생할 때마다 문서도 수정하여 다시 공유해야 하는 점이 번거롭고, 사실 문서 정리부터 번거롭다. 이때 Swagger를 사용하게 되면 API 문서 자동화로 따로 문서로 정리할 필요도 없을 뿐만 아니라 UI에서 직접 API를 테스트해볼 수 있기 때문에 편리하다. 즉, 서버로... Swagger스프링부트Swagger NestJS - 2 Swagger로 API 문서 작성하기 이번에는 API문서를 보여주는 툴인 Swagger를 Nest에 적용시켜보고자한다. Nest 공식 문서에 가면 swagger 세팅 법까지 전부 나와있는데, 그걸 우선 똑같이 쓴다. 후에 프로젝트의 main.ts에 들어가 swagger를 사용하겠다고 선언을 해주면 된다. title, description, version은 추후에 확인할 수 있으니 보고 수정하면 된다. 이것이 url에서 endpo... NestJSAPI문서expressSwaggerAPI문서 Open API(Swagger) 공통 Header 생성 SwaggerJavaJava 드디어 마주친 작심삼일? 그럼 내일은 또 다시 작심일일 시작하자! (Code camp FE 6기) 이렇게 바로바로 치면서 도출값을 볼 수 있기때문에, 오류가 있는지 없는지 바로바로 확인할수 있다 ! - http Request, Response 텍스트/하이퍼텍스트(HTML)의 길 - HTTP - API 프론트엔드는 해당 API에 저장을 요청할 수 있다. (백엔드의 API는 사실 하나의 함수라고 한다 SaveProfile()과 같은...) 백엔드에서 어떠한 형식으로 API를 만들어 주는가! ... graphqlPlayground프론트엔드algorithmjsonSwagger202203REST코드캠프6기CRUDpostmanAPI202203 [TIL] NestJS 공부 38일차 OpenAPI란 RESTfulAPI를 설명하는데 사용 언어에 구애받지 않고 정의하는 형식입니다. Swagger를 이용해서 API를 설명합시다. 설치 만약 fastify를 사용한다면 아래의 명령어를 대신해주면 되지만 저는 fastify보단 전에 한번 써본 모듈로 해보겠습니다. 스웨거 사용 위 코드는 Swagger를 초기화시켜주는 기본 문구들입니다. Swagger에서 기본인 Title, Desc... SwaggerSwagger API 문서 웹에 만들기 실무에서 API를 만들다가 엑셀로 API문서를 정리하는게 귀찮았으며 로컬에서 바로 확인 할 수 있게 만들기 위해 Swagger 를 사용해 보았다. request를 주면 response 받는 형식을 알아보기 쉽게 만들어져 있어서 만족하며 사용했다. xml 의존성 추가 gradle 의존성 추가 maven, gradle 상황에 맞는 의존성을 추가해준다. 그다음 swagger를 등록해야 하는데 패키... SwaggerJavaAPIAPI [Spring] 나만의 게시판 만들기 5 - Swagger 설정 Swagger를 통해 REST API로 개발한 내용의 문서화가 가능하며, 간단한 테스팅 작업을 UI로 표현 가능하기 때문에 사용했습니다. Shoooooooot! 스프링의 gradle에 의존성을 추가하여 swagger를 사용할 수 있도록 합니다. @Configuration : 설정 파일을 가르키는 스프링 애노테이션입니다. 이를 통해, 스프링 빈 컨테이너에서 해당 클래스를 설정 클래스로 간주합니... SwaggerSpringSpring [Swagger] Spring Boot, Gradle 환경에서 Swagger 적용하기 build.gradle 최신 버전인 Swagger 3.x 버전을 적용 Swagger 2.x 버전보다 간단하게 springfox-boot-starter 하나 추가로 필요한 모든 라이브러리 포함 가능 SwaggerConfig.java configuration 파일 SwaggerConfig.java 추가 Docket: Swagger 설정의 핵심이 되는 Bean useDefaultResponseMe... SwaggergradleSpringbootSpringboot Springboot 통합 Swagger 작업 단계 Swagger는 RESTful 스타일의 웹 서비스를 생성, 설명, 호출, 시각화하는 데 사용되는 규범적이고 완전한 프레임워크입니다.전체 목표는 클라이언트와 파일 시스템을 서버로 똑같은 속도로 업데이트하는 것이다.역할: 인터페이스의 문서가 온라인으로 자동으로 생성됩니다 기능 테스트.. 1단계:pom을 설정합니다.xml 2단계: IDEA 실행 Reimport All Maven Projects 3... Swaggerspringboot Laavel에서 OpenAPI/Swagger를 사용한 Feature 테스트 개발된 API가 OpenAPI/Swagger와 같은지 테스트할 수 있다면 좋겠습니다. 이렇게 멋진 기사가 나왔는데 코드 양이 많아져서 좀 간단하게 할 수 있을까 해서요. 이런 좋은 점을 발견해서 사용해 봤어요. PHP 8.1.4 이번에 시도한 소스 코드 OpenAPI 준비 openapi.yaml Stoplight의 미리보기에서 이런 느낌입니다. 와 같이 hotmeteor/spectator에 ... LaravelPHPSwagger테스트OpenAPItech Swashbuckle.AspNetCore v5.0.0 이후 처리 옵션의 유형이 변경되었습니다. 만약 마이크로소프트의 공식 참고를 추구한다면 정보는 업데이트될 것이다 Swashbuckle 및 ASP.NET Core의 개요 Swashbuckle.5.0.0 미만 Startup.cs Swashbuckle.AspNetCore version 5.0.0 이상 Startup.cs 참고 자료 Why Swashbuckle.aspnet.core.swagger not being recognized - st... dotnetcoreSwaggeraspdotnetcoreswashbuckletech