aspnet quickstart minapi user profile
1.0.0
Этот репо предназначен для того, чтобы научить вас подключиться к кластеру Couchbase для создания, чтения, обновления и удаления документов, а также как писать простые параметризованные запросы N1QL, используя новую минимальную структуру API API.
Полную документацию можно найти на портале разработчика Couchbase.
Чтобы запустить этот предварительно построенный проект, вам понадобится:
cd src/Couchbase.Quickstart
dotnet restoreПРИМЕЧАНИЕ: Auto Restore Nuget Packages при создании проекта в Visual Studio Professional и Visual Studio для Mac
Couchbase SDK для .NET включает в себя пакет NUGET под названием Couchbase.Extensions.DependencyInjection , который предназначен для средств, таких как ASP.NET, которая принимает конфигурацию для подключения к Couchbase и автоматически регистрирует интерфейсы, которые вы можете использовать в своем коде для выполнения полной CRUD (create, read, update, delete) операции и запросы против данных DATABASE.
Вся конфигурация для связи с базой данных хранится в файле appsettings.development.json. Это включает в себя строку подключения, имя пользователя, пароль, имя ведра, имя Colleciton и имя масштаба. Предполагается, что имя пользователя по умолчанию является admin , а пароль по умолчанию считается P@$$w0rd12 . Если они отличаются в вашей среде, вам нужно будет изменить их перед запуском приложения.
С помощью этого урока требуется, чтобы пользователь и ведро базы данных были созданы до запуска приложения.
Для пользователей Capella следуйте указаниям, найденным на веб -сайте документации для создания ведра под названием user_profile . Затем следуйте указаниям для настройки учетных данных базы данных; Назовите его admin с паролем P@$$w0rd12 .
Далее откройте файл 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 вернет ошибки при запуске API.
Для локальной установки и пользователей Docker следуйте указаниям, найденным на веб -сайте документации для создания ведра под названием user_profile . Затем следуйте инструкциям для создания пользователя; Назовите его admin с паролем P@$$w0rd12 . Для этого урока убедитесь, что у него есть Full Admin , чтобы приложение могло создавать коллекции и индексы.
Затем откройте файл appsettings.development.json и проверьте информацию о конфигурации соответствует вашей настройке.
Примечание. Для установки Docker и Local Couchbase должны быть установлены Couchbase и работа на Localhost (http://127.0.0.1:8091) перед запуском приложения ASP.NET.
На этом этапе приложение готово, и вы можете запустить его:
cd src/Couchbase.Quickstart
dotnet runПосле того, как сайт будет запущен и запускается, вы можете запустить свой браузер и перейти на страницу Swagger Start, чтобы проверить API.
Чтобы запустить стандартные интеграционные тесты, используйте следующие команды:
cd ../Couchbase.Quickstart.IntegrationTests/
dotnet restore
dotnet build
dotnet test Этот проект был основан на стандартном проекте шаблона ASP.NET, и API погоды по умолчанию был удален.
Настройка базового API REST в минимальных API ASP.NET с Couchbase довольно проста. Этот проект при запуске создаст коллекцию, индекс для нашего параметризованного запроса N1QL, и демонстрирует основные операции CRUD, необходимые в большинстве приложений.
