aspnet quickstart minapi user profile

C# 및 ASP.NET 6 최소 API와 함께 Couchbase의 QuickStart

Couchbase의 C# SDK 3 및 ASP.NET 최소 API로 REST API를 구축하십시오.

이 repo는 Couchbase 클러스터에 연결하여 문서를 작성, 읽기, 업데이트 및 삭제하는 방법과 새로운 ASP.NET 최소 API 프레임 워크를 사용하여 간단한 매개 변수화 된 N1QL 쿼리를 작성하는 방법을 가르쳐 주도록 설계되었습니다.

전체 문서는 Couchbase Developer Portal에서 찾을 수 있습니다.

전제 조건

이 사전 제작 된 프로젝트를 실행하려면 다음과 같이 필요합니다.

• Couchbase 설치 옵션을 따르십시오. 가장 마지막 Couchbase 데이터베이스 서버 인스턴스를 설치하십시오.
• .NET SDK V6+ 설치
• 코드 편집기 설치 (Visual Studio Professional, Mac 용 Visual Studio 또는 Visual Studio Code)

종속성을 설치하십시오

 cd src/Couchbase.Quickstart
dotnet restore

참고 : NUGET 패키지 Mac 용 프로젝트 및 Visual Studio에서 프로젝트를 구축 할 때 자동 복원

종속성 주입 너겟 패키지

.NET 용 Couchbase SDK에는 Couchbase.Extensions.DependencyInjection 과 같은 환경에 대해 Couchbase에 연결하고 코드에서 사용할 수있는 인터페이스를 자동으로 등록하는 인터페이스 CRUD (create, read, update, delete) 작업 및 queries가 데이터베이스에 대한 자동으로 등록하는 Nuget 패키지가 포함되어 있습니다.

데이터베이스 서버 구성

데이터베이스와의 통신을위한 모든 구성은 AppSettings.Development.json 파일에 저장됩니다. 여기에는 연결 문자열, 사용자 이름, 비밀번호, 버킷 이름, CollecitOn 이름 및 범위 이름이 포함됩니다. 기본 사용자 이름은 admin 라고 가정하고 기본 비밀번호는 P@$$w0rd12 라고 가정합니다. 환경에서 다른 경우 응용 프로그램을 실행하기 전에 변경해야합니다.

버킷, 사용자 이름 및 비밀번호 생성

이 자습서를 사용하면 응용 프로그램을 실행하기 전에 데이터베이스 사용자 및 버킷을 작성해야합니다.

카펠라 사용자

Capella 사용자의 경우 user_profile 이라는 버킷을 만들기 위해 문서 웹 사이트에있는 지시 사항을 따르십시오. 그런 다음 데이터베이스 자격 증명 구성에 대한 지침을 따르십시오. P@$$w0rd12 의 비밀번호로 admin 이름을 지정하십시오.

다음으로 AppSettings.Development.json 파일을 엽니 다. ConnectionString 속성을 찾아 Capella Portal UI Connect 탭에있는 광범위한 지역 네트워크 이름과 일치하도록 업데이트하십시오. Capella는 TLS를 사용하므로 연결 문자열은 Couchbases : //에서 시작해야합니다. 이 구성은 개발 환경에만 설계되었습니다.

  "Couchbase" : {
    "BucketName" : " user_profile " ,
    "ScopeName" : " _default " ,
    "CollectionName" : " profile " ,
    "ConnectionString" : " couchbases://yourassignedhostname.cloud.couchbase.com " ,
    "Username" : " admin " ,
    "Password" : " P@$$w0rd12 " ,
    "IgnoreRemoteCertificateNameMismatch" : true ,
    "HttpIgnoreRemoteCertificateMismatch" : true ,
    "KvIgnoreRemoteCertificateNameMismatch" :  true
  }

Couchbase Capella 사용자는 이러한 방향을 따르지 않는 사용자는 예외 오류가 발생하며 Swagger Portal은 API를 실행할 때 오류를 반환합니다.

로컬 설치 및 도커 사용자

로컬 설치 및 Docker 사용자의 경우 user_profile 이라는 버킷을 작성하려면 문서 웹 사이트에있는 지시 사항을 따르십시오. 다음으로, 사용자를 만들기위한 지침을 따르십시오. P@$$w0rd12 의 비밀번호로 admin 이름을 지정하십시오. 이 튜토리얼의 경우 응용 프로그램이 컬렉션 및 인덱스를 생성 할 수 있도록 Full Admin 권한이 있는지 확인하십시오.

다음으로 AppSettings.Development.json 파일을 열고 구성 정보가 설정과 일치하는 유효성 검사.

참고 : Docker 및 Local Couchbase 설치의 경우 ASP.NET 앱을 실행하기 전에 Couchbase를 LocalHost (http://127.0.0.1:8091)에 설치하고 실행해야합니다.

응용 프로그램 실행

이 시점에서 응용 프로그램이 준비되었으며 실행할 수 있습니다.

 cd src/Couchbase.Quickstart
dotnet run

사이트가 시작되고 실행되면 브라우저를 시작하고 Swagger 시작 페이지로 이동하여 API를 테스트 할 수 있습니다.

테스트 실행

표준 통합 테스트를 실행하려면 다음 명령을 사용하십시오.

 cd ../Couchbase.Quickstart.IntegrationTests/
dotnet restore 
dotnet build
dotnet test 

프로젝트 설정 노트

이 프로젝트는 표준 ASP.NET 템플릿 프로젝트를 기반으로했으며 기본 날씨 API가 제거되었습니다.

결론

Couchbase를 사용하여 ASP.NET 최소 API에서 기본 REST API를 설정하는 것은 매우 간단합니다. 이 프로젝트는 실행할 때 매개 변수화 된 N1QL 쿼리의 색인 인 컬렉션을 생성하고 대부분의 응용 프로그램에 필요한 기본 CRUD 작업을 보여줍니다.