SpringBootRestAPI

restapi 템플릿 - 스프링 부트 + mongodb

하강

Spring-Boot-Microservices를 사용하여 REST API를위한 즉시 사용 가능한 템플릿, MongoDB는 Codecov 및 Sonarqube와 통합되어 클라우드에 배포 할 수 있습니다. 이 템플릿은 모든 응용 프로그램에 연결하여 모든 것을 처음부터 쓰지 않고 쉽게 킥 스타트 작업을 수행 할 수 있습니다.

작업 목록 진행 상황

• SpringBoot를 사용하는 REST 컨트롤러 및 모델
• MongoDB 구성
• Travisci 빌드
• Sonarqube 통합
• Jacoco 테스트 보고서
• JWT 인증
• 80% 이상 코드 적용 범위 (Codecov 또는 Coveralls 사용)
• 클라우드 배포

시작하기

• 이 프로젝트를 포크 및이 저장소의 체크 아웃 후 좋아하는 IDE로 가져 오십시오.

사전 반제 및 설치 단계

• 연결할 수있는 MongoDB의 실행중인 인스턴스를 얻으십시오. MongoDB를 시작하는 것에 대한 자세한 내용은 온라인 자습서를 방문하십시오.

• 테스트 데이터베이스를 작성하여 시작하십시오. MongoDB Shell의 다음 명령을 사용하여 또는 MongoDB Compass와 같은 데이터베이스 관리자를 통해 내 "rest_tutorial"이라고 부를 것입니다. use rest_tutorial;

• 다양한 유형의 애완 동물에 대한 데이터를 보유 할 샘플 컬렉션을 만듭니다. 다음 명령으로 컬렉션을 만들어 봅시다 : db.createCollection("pets");

• 컬렉션이 생성되면 일부 데이터를 추가해야합니다! 아래 쿼리를 사용하여 컬렉션에 데이터를 추가 할 수 있습니다. db.pets.insertMany([ { "name" : "Spot", "species" : "dog", "breed" : "pitbull" }, { "name" : "Daisy", "species" : "cat", 종 "name" : "Bella", "breed" : "calico" " }, { "species" : "dog", "breed" : "australian shepard" } ]);

• Application.properties 인증이없는 경우 MongoDB Authentication-Database, 사용자 이름 및 비밀번호를 추가하면이 파일에서 이러한 속성을 제거 할 수도 있습니다.

• 데이터베이스에서 사용자 역할을 만듭니다. 사용자 역할은 "사용자, 중재자 또는 관리자"중 하나 일 수 있습니다.

 db.roles.insertMany([
   { name: "ROLE_USER" },
   { name: "ROLE_MODERATOR" },
   { name: "ROLE_ADMIN" },
])

테스트 실행

서버가 시작되면 먼저 사용자를 등록하고 해당 사용자로 로그인해야합니다.

사용자 등록

사용자 로그인

토큰을 얻으면 우체부의 백엔드에 대한 모든 요청에 ​​대해 해당 토큰을 전달해야합니다. "헤더"섹션을 선택하고 키 및 키에 대한 Authorization 입력하십시오.
가치에 대한 "베어러"

선택한 API를 자유롭게 테스트 할 수 있습니다. 아래 테스트를 위해 우체부를 사용하십시오.

getAllpets

getpetbyid

CreatePet

deletepet

modifypetbyid

모든 테스트를 수행 한 후에는 Endpoint /api/auth/logout 사용하여 로그 아웃 할 수 있습니다.

로그 아웃

코드 적용 범위

Code Coverage Reports 통합의 경우 Codecov 및 Coveralls를 사용하여 예제를 보여 주었고 Travis와 쉽게 통합하기 쉽습니다.

• Codecov- .travis.yml 에이 줄을 추가하여 Jacoco 보고서를 Codecov 콘솔로 보낼 것입니다.

• Coverals -Build.gradle 파일에 Coverals Plugin 및 Jacoco Report Path를 추가해야합니다. CodeCov 대신 .travis.yml에서 변경이 필요합니다.

요청 템플릿 문제

Are you up for your first Issue Request for this project !!! 굉장하지만 먼저 문제 template.md를 살펴 보고이 템플릿을 사용하여 모든 문제 요청을 제출하십시오.

요청 템플릿을 당기십시오

Are you up for your first PR for this project !!! 굉장하지만 먼저 풀 요청 템플릿을 살펴 보고이 템플릿을 사용하여 PR을 제출하십시오.

기여

당사의 행동 강령에 대한 자세한 내용과 당사에 풀 요청을 제출하는 프로세스는 Contributing.md 및 Coder of Coder.md를 읽으십시오.

저자

• Gourav Rusiya