aspnet quickstart
1.0.0
Часто первые разработчики делают после создания своей базы данных создание API REST, который может выполнять операции создания, чтения, обновления и удаления (CRUD) для этой базы данных. Этот репо предназначен для того, чтобы научить вас и дать вам стартовый проект (в C# с использованием ASP.NET) для создания такого API отдыха. После того, как вы установили ведро для провозможного образца в базе данных, вы можете запустить это приложение, которое является API REST с документацией Swagger, чтобы вы могли выучить:
Полную документацию можно найти на портале разработчика Couchbase.
Если вы ищете QuickStart, используя минимальный API ASP.NET, вы можете найти его в этом репо.
Чтобы запустить этот предварительно построенный проект, вам понадобится:
Мы пройдем через различные шаги, необходимые для запуска приложения.
git clone https://github.com/couchbase-examples/aspnet-quickstart.git cd src/Org.Quickstart.API
dotnet restore Couchbase SDK для .NET включает в себя пакет NUGET под названием Couchbase.Extensions.DependencyInjection , который предназначен для средств, таких как ASP.NET, которая принимает конфигурацию для подключения к Couchbase и автоматически регистрирует интерфейсы, которые вы можете использовать в своем коде для выполнения полной CRUD (create, read, update, delete) операции и запросы против данных DATABASE.
Чтобы узнать больше о подключении к своему кластеру Capella, пожалуйста, следуйте инструкциям.
В частности, вам нужно сделать следующее:
Вся конфигурация для связи с базой данных хранится в файле appsettings.development.json. Это включает в себя строку подключения, имя пользователя, пароль, имя ведра и имя масштаба. Предполагается, что имя пользователя по умолчанию является Administrator , а пароль по умолчанию считается P@$$w0rd12 . Если они отличаются в вашей среде, вам нужно будет изменить их перед запуском приложения.
"Couchbase" : {
"BucketName" : " travel-sample " ,
"ScopeName" : " inventory " ,
"ConnectionString" : " couchbases://yourassignedhostname.cloud.couchbase.com " ,
"Username" : " Administrator " ,
"Password" : " P@ssw0rd12 " ,
"IgnoreRemoteCertificateNameMismatch" : true ,
"HttpIgnoreRemoteCertificateMismatch" : true ,
"KvIgnoreRemoteCertificateNameMismatch" : true
}
ПРИМЕЧАНИЕ. Строка подключения ожидает
couchbases://илиcouchbase://Часть.
На этом этапе мы установили зависимости, загрузили данные о примере и настроили приложение с учетными данными. Приложение теперь готово, и вы можете запустить его.
cd src/Org.Quickstart.API
dotnet run cd aspnet-quickstart
docker build -t couchbase-aspnet-quickstart . cd aspnet-quickstart
docker run -e DB_CONN_STR= < connection_string > -e DB_USERNAME= < user_with_read_write_permission_to_travel-sample_bucket > -e DB_PASSWORD= < password_for_user > -p 8080:8080 couchbase-aspnet-quickstartВы можете получить доступ к приложению на http: // localhost: 8080/index.html
После того, как приложение запустится, вы можете увидеть детали приложения в журналах.
Приложение будет запускать на порту 8080 вашей локальной машины (http: // localhost: 8080/index.html). Вы найдете документацию API Swagger, если вы пойдете на URL в своем браузере. Документация Swagger используется в этой демонстрации для демонстрации различных конечных точек API и того, как их можно использовать. Более подробную информацию о документации Swagger можно найти в Приложении.
Чтобы запустить стандартные интеграционные тесты, используйте следующие команды:
cd ../Org.Quickstart.IntegrationTests/
dotnet restore
dotnet build
dotnet test Для этого QuickStart мы используем три коллекции, аэропорт, авиакомпании и маршруты, которые содержат образец аэропортов, авиакомпании и маршрутов авиакомпаний соответственно. Коллекция маршрутов соединяет аэропорты и авиакомпании, как показано на рисунке ниже. Мы используем эти соединения в QuickStart для генерации аэропортов, которые напрямую подключены, и авиакомпании, подключающиеся к аэропорту назначения. Обратите внимание, что это просто примеры, чтобы подчеркнуть, как вы можете использовать запросы SQL ++ для присоединения к коллекциям.
Если вы хотите добавить еще одну сущность в API, это шаги, которые нужно следовать:
Controllers , аналогичных существующим маршрутам.Org.Quickstart.IntegrationTests , аналогичной AirportTests.cs .Если вы запускаете этот QuickStart с самостоятельным кластером Couchbase, вам необходимо загрузить ведро для примерного образца в свой кластер и генерировать учетные данные для ведра.
Вам необходимо обновить строку подключения и учетные данные в файле appsettings.development.json в папке Source.
Примечание. Должен быть установлен Couchbase и запустить до запуска приложения ASP.NET.
Документация Swagger предоставляет четкое представление об API, включая конечные точки, методы HTTP, параметры запроса и объекты ответа.
Нажмите на отдельную конечную точку, чтобы развернуть ее и посмотреть подробную информацию. Это включает в себя описание конечной точки, возможные коды состояния ответа и параметры запроса, которые он принимает.
Вы можете попробовать API, нажав кнопку «Попробуй» рядом с конечными точками.
Параметры: Если конечная точка требует параметров, Swagger UI предоставляет входные ящики для вас.
Выполнение: После того, как вы ввели все необходимые параметры, вы можете нажать кнопку «Выполнить», чтобы сделать живой вызов API. Swagger UI отправит запрос в API и отобразит ответ непосредственно в документации. Это включает в себя код ответа, заголовки ответов и тело ответа.
Swagger документирует структуру запросов и ответных тел с использованием моделей. Эти модели определяют ожидаемую структуру данных с использованием схемы JSON и чрезвычайно полезны для понимания того, какие данные отправлять и ожидать.
