ChiselNow: obtenha uma API CRUD totalmente funcional em minutos

Nov 29 2022
A maneira mais rápida e fácil de criar uma API CRUD completa. Acho que não há nada melhor do que ChiselNow para isso.
Construir back-end é demorado e comparativamente mais difícil para desenvolvedores de front-end. Mesmo se você usar uma ferramenta de automação de back-end, precisará escrever alguns scripts, criar endpoints, modelos etc.

Construir back-end é demorado e comparativamente mais difícil para desenvolvedores de front-end. Mesmo se você usar uma ferramenta de automação de back-end, precisará escrever alguns scripts, criar endpoints, modelos etc.

Para ajudar os desenvolvedores a fazer o mesmo, lançamos o ChiselNow , o caminho mais curto para um back-end totalmente funcional em minutos.

Basta criar o front-end, definir seu modelo em TypeScript e obter uma API REST completa pronta para uso com apenas alguns cliques. Nenhuma inscrição ou cartão de crédito é necessário, não custa nada para começar.

Vamos aprender como criar APIs CRUD totalmente funcionais com o ChiselNow.

Construindo a API CRUD

Vá para ChiselNow e role um pouco para baixo. Existem alguns exemplos de modelo para sugerir diferentes tipos de casos de uso que o ChiselNow suporta. Você também pode escrever sua própria classe TypeScript para explorar a ferramenta.

Página inicial do ChiselNow

Vamos pegar o exemplo do modelo fornecido: Encurtador de URL.
Clique na opção URL Shortener e você poderá ver o modelo no editor de código.

  • O modelo tem um nome de classe padrão e algumas propriedades. Para este tutorial, vamos usá-los como estão.
  • Aceite os termos e condições marcando a caixa no canto esquerdo do editor.
  • Agora, na etapa final, clique em “Create your API now”. Levará cerca de 30 segundos para criar uma API e é isso.
  • Modelo de encurtador de URL para criar API CRUD
Uma API CRUD totalmente funcional foi criada

Copie o Endpoint e a API Key em seu sistema porque eles não podem ser recuperados depois que você sair da página.

Exercitando a API

Uma breve descrição dos termos usados ​​ao trabalhar com APIs.

  • Endpoint: este URL será usado para fazer solicitações HTTP na API gerada e você expandirá isso com parâmetros de string de consulta.
  • Chave API: A chave API é usada para autorização e precisa ser fornecida em cada solicitação no cabeçalho HTTP X-Token.
  • Comandos CURL: Esta é uma coleção de comandos de exemplo que você pode usar para ler e gravar dados de entidade.

O método POST : É usado para adicionar entidades ao banco de dados.

curl -X POST \
-d ‘{“originalUrl”:”Fake String”,”shortenedUrl”:”Fake String”,”expiresAt”:”2022–11–18T12:49:22.216Z”}’ \
-H ‘X-Token: YOUR-UNIQUE-API-KEY’ \
‘https://YOUR-UNIQUE-PROJECT-NAME-chiselnow.chiselstrike.io/main/url-shorteners'

{
  “id”:”a54942da-6d05–48d9-b4e5-bd628306f652",
  ”originalUrl”:”Fake String”,
  ”shortenedUrl”:”Fake String”,
  ”expiresAt”:”2022–11–18T12:49:22.216Z”
}

curl : É usado para consultar todas as entidades.

curl ‘https://YOUR-UNIQUE-PROJECT-NAME-chiselnow.chiselstrike.io/main/url-shorteners

{
   "next_page":"/main/url-shorteners?cursor=eyJheGVzIjpbeyJrZXkiOnsiZmllbGROYW1lIjoiaWQiLCJhc2NlbmRpbmciOnRydWV9LCJ2YWx1ZSI6ImZjM2VkYzU2LTE5MjYtNGE5ZC1hYmY2LTQwYTU3NmQ3MDhiNiJ9XSwiZm9yd2FyZCI6dHJ1ZSwiaW5jbHVzaXZlIjpmYWxzZX0%3D",
   "prev_page":"/main/url-shorteners?cursor=eyJheGVzIjpbeyJrZXkiOnsiZmllbGROYW1lIjoiaWQiLCJhc2NlbmRpbmciOnRydWV9LCJ2YWx1ZSI6IjkwZWZkNmRkLTM2ZGQtNDkwMS04MmRjLTlkYTQzZTNjODc3MyJ9XSwiZm9yd2FyZCI6ZmFsc2UsImluY2x1c2l2ZSI6ZmFsc2V9",
   "results":[
      {
         "originalUrl":"Fake String 2",
         "shortenedUrl":"Fake String 2",
         "id":"UNIQUE_ID",
         "expiresAt":EXPIRE_TIME
      },
      {
         "shortenedUrl":"Fake String 1",
         "id":"UNIQUE_ID",
         "originalUrl":"Fake String 1",
         "expiresAt":EXPIRE_TIME
      },
      {
         "id":"UNIQUE_ID",
         "expiresAt":EXPIRE_TIME,
         "shortenedUrl":"Fake String 0",
         "originalUrl":"Fake String 0"
      }
   ]
}

O método DELETE : É usado para deletar todas as entidades do projeto. Lembre-se, isso não pode ser desfeito.

curl -X DELETE \
-H ‘X-Token: YOUR-UNIQUE-API-KEY’ \ 
‘https://YOUR-UNIQUE-PROJECT-NAME-chiselnow.chiselstrike.io/main/url-shorteners?all=true'

“Deleted entities matching ?all=true”

Resultado:

{“results”:[]}

O projeto vem com alguns limites: além dos limites de armazenamento e largura de banda, ele é excluído automaticamente em dois dias. Para continuar usando sua API, retendo os dados que você gerou, você pode importar o projeto para a plataforma ChiselStrike.

Formas de importar o projeto

Existem duas maneiras de importar o projeto:

Na tela do ChiselNow
Para importar o aplicativo, clique no botão “Importar” à direita.

Importando o projeto da tela do ChiselNow

Faça login com sua conta do GitHub.

Entre com sua conta do GitHub

ChiselStrike pedirá permissão para ler e escrever repositórios. Clique em “Authorize ChiselStrike” para dar permissão.

Permissão para ler e escrever repositórios

Agora, clique em “Criar um repositório Git vazio”, que o levará a criar um novo repositório no GitHub. Assim que o repositório for criado.

Preencha os campos com seu nome de usuário do Github, nome do repositório e nome do projeto, respectivamente.

Clique em “Continuar” e pronto!

Importando o projeto

Agora, você tem o link do projeto ao vivo, rotas e todas as outras informações sobre o projeto no ChiselStrike.

Link e rotas do projeto ao vivo

Da plataforma ChiselStrike

Se você já possui uma conta ChiselStrike, acesse o Painel ChiselStrike. Clique em “Novo Projeto”.

Painel do ChiselStrike

Agora, clique em “Import ChiselNow Project”.

Importando o projeto ChiselNow

Semelhante ao método anterior, você terá que criar um novo repositório GitHub e fornecer acesso ao ChiselStrike.

Preencha os campos com seu nome de usuário do Github, nome do repositório, nome do projeto, URL do endpoint e chave de API que você recebeu quando criou o projeto pela primeira vez. Você vai precisar disso aqui.

Clique em “Continuar” e pronto!

Preenchendo o URL do endpoint e a chave de API que você salvou anteriormente

O projeto também foi enviado para o seu repositório GitHub. Tudo é importado automaticamente para os repositórios do GitHub, incluindo rotas, modelos e políticas. Você também pode aprender mais sobre o que mais pode ser feito com o ChiselStrike verificando a documentação .

Código do projeto enviado para o repositório do GitHub

Parabéns, agora você tem um projeto totalmente funcional com ChiselNow. Você pode acessar seu GitHub, adicionar mais recursos, escrever código de back-end, modificar os modelos, etc. Você pode ver que o código foi enviado para seu repositório GitHub.

Nos modelos, você pode ver que há três propriedades: URL original, URL abreviada e data de expiração. Você pode alterar o nome das propriedades ou seu tipo e reescrever os modelos de acordo com o projeto. Percorra a documentação para saber mais sobre isso.

Código dos modelos

As rotas são onde você define seus endpoints. Você pode consultar a documentação para saber mais sobre isso.

Código de rotas

Para construir um back-end mais complexo e levar seu protótipo para produção, confira nossa página de documentação .

Informe-nos se você criar algo legal usando ChiselStrike ou ChiselNow em nosso Discord ou Twitter .