aspnet quickstart
1.0.0
Freqüentemente, o primeiro passo que os desenvolvedores fazem após a criação de seu banco de dados é criar uma API REST que possa executar operações de criação, leitura, atualização e exclusão (CRUD) para esse banco de dados. Este repositório foi projetado para ensiná -lo e fornecer um projeto inicial (em C# usando asp.net) para gerar uma API REST. Depois de instalar o balde de amostra de viagem em seu banco de dados, você pode executar este aplicativo, que é uma API REST com documentação de Swagger para que você possa aprender:
A documentação completa pode ser encontrada no portal do desenvolvedor da Couchbase.
Se você estiver procurando um Iniciar o Quickstart usando a API mínima do ASP.NET, poderá encontrá -lo neste repositório.
Para executar este projeto pré -construído, você precisará:
Passamos pelas diferentes etapas necessárias para executar o aplicativo.
git clone https://github.com/couchbase-examples/aspnet-quickstart.git cd src/Org.Quickstart.API
dotnet restore O Couchbase SDK para .NET inclui um pacote NUGET chamado Couchbase.Extensions.DependencyInjection , projetado para ambientes como o ASP.NET que recebe uma configuração para conectar -se ao CouchBase e registra automaticamente interfaces que você pode usar em seu código para executar CRUD (create, read, update, delete) e, as operações e seriam que você pode usar o código completo.
Para saber mais sobre como se conectar ao seu cluster Capella, siga as instruções.
Especificamente, você precisa fazer o seguinte:
Toda a configuração para comunicação com o banco de dados é armazenada no arquivo appSsets.Development.json. Isso inclui a string de conexão, nome de usuário, senha, nome do balde e nome do escopo. Presume -se que o nome de usuário padrão seja Administrator e a senha padrão é assumida como P@$$w0rd12 . Se estes forem diferentes em seu ambiente, você precisará alterá -los antes de executar o aplicativo.
"Couchbase" : {
"BucketName" : " travel-sample " ,
"ScopeName" : " inventory " ,
"ConnectionString" : " couchbases://yourassignedhostname.cloud.couchbase.com " ,
"Username" : " Administrator " ,
"Password" : " P@ssw0rd12 " ,
"IgnoreRemoteCertificateNameMismatch" : true ,
"HttpIgnoreRemoteCertificateMismatch" : true ,
"KvIgnoreRemoteCertificateNameMismatch" : true
}
Nota: A sequência de conexão espera as
couchbases://oucouchbase://parte.
Nesse ponto, instalamos as dependências, carregamos os dados da amostra de viagem e configuramos o aplicativo com as credenciais. O aplicativo agora está pronto e você pode executá -lo.
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-quickstartVocê pode acessar o aplicativo em http: // localhost: 8080/index.html
Depois que o aplicativo é iniciado, você poderá ver os detalhes do aplicativo nos logs.
O aplicativo será executado na porta 8080 da sua máquina local (http: // localhost: 8080/index.html). Você encontrará a documentação da Swagger da API se for ao URL no seu navegador. A documentação do Swagger é usada nesta demonstração para mostrar os diferentes pontos finais da API e como eles podem ser invocados. Mais detalhes sobre a documentação do Swagger podem ser encontrados no apêndice.
Para executar os testes de integração padrão, use os seguintes comandos:
cd ../Org.Quickstart.IntegrationTests/
dotnet restore
dotnet build
dotnet test Para esse início rápido, usamos três coleções, aeroporto, companhias aéreas e rotas que contêm aeroportos de amostra, companhias aéreas e rotas aéreas, respectivamente. A coleção de rotas conecta os aeroportos e companhias aéreas, como visto na figura abaixo. Utilizamos essas conexões no Quickstart para gerar aeroportos conectados diretamente e as companhias aéreas conectadas a um aeroporto de destino. Observe que esses são apenas exemplos para destacar como você pode usar consultas SQL ++ para participar das coleções.
Se você deseja adicionar outra entidade às APIs, essas são as etapas a seguir:
Controllers semelhantes às rotas existentes.Org.Quickstart.IntegrationTests semelhante ao AirportTests.cs .Se você estiver executando esse início rápido com um cluster de Couchbase auto-gerenciado, precisará carregar o balde de dados da amostra de viagem em seu cluster e gerar as credenciais para o balde.
Você precisa atualizar a string de conexão e as credenciais no arquivo appSsets.Development.json na pasta de origem.
NOTA: O Couchbase deve ser instalado e executado antes da execução do aplicativo ASP.NET.
A documentação do Swagger fornece uma visão clara da API, incluindo pontos de extremidade, métodos HTTP, parâmetros de solicitação e objetos de resposta.
Clique em um terminal individual para expandi -lo e ver informações detalhadas. Isso inclui a descrição do endpoint, possíveis códigos de status de resposta e os parâmetros de solicitação que ele aceita.
Você pode experimentar uma API clicando no botão "Experimente" ao lado dos pontos de extremidade.
Parâmetros: se um ponto de extremidade exigir parâmetros, a interface do usuário do Swagger fornecerá caixas de entrada para você preencher. Isso pode incluir parâmetros de caminho, cadeias de consultas, cabeçalhos ou o corpo de uma solicitação de postagem/put.
Execução: Depois de inserir todos os parâmetros necessários, clique no botão "Executar" para fazer uma chamada de API ao vivo. A interface do usuário do Swagger enviará a solicitação para a API e exibirá a resposta diretamente na documentação. Isso inclui o código de resposta, cabeçalhos de resposta e corpo de resposta.
Swagger documenta a estrutura dos órgãos de solicitação e resposta usando modelos. Esses modelos definem a estrutura de dados esperados usando o esquema JSON e são extremamente úteis para entender quais dados enviar e esperar.
