ChiselNow : Obtenez une API CRUD entièrement fonctionnelle en quelques minutes

Nov 29 2022
Le moyen le plus rapide et le plus simple de créer une API CRUD complète. Je ne pense pas qu'il y ait quelque chose de mieux que ChiselNow pour cela.
La construction du backend prend du temps et est relativement plus difficile pour les développeurs frontend. Même si vous utilisez un outil d'automatisation backend, vous devez écrire quelques scripts, créer des points de terminaison, des modèles, etc.

La construction du backend prend du temps et est relativement plus difficile pour les développeurs frontend. Même si vous utilisez un outil d'automatisation backend, vous devez écrire quelques scripts, créer des points de terminaison, des modèles, etc.

Pour aider les développeurs à faire de même, nous avons lancé ChiselNow , le chemin le plus court vers un backend entièrement fonctionnel en quelques minutes.

Créez simplement l'interface, définissez votre modèle dans TypeScript et obtenez une API REST complète prête à l'emploi en quelques clics. Aucune inscription ou carte de crédit n'est requise, cela ne coûte rien pour commencer.

Allons-y et apprenons à créer des API CRUD entièrement fonctionnelles avec ChiselNow.

Construire l'API CRUD

Allez à ChiselNow et faites défiler un peu. Il existe quelques exemples de modèles pour suggérer différents types de cas d'utilisation pris en charge par ChiselNow. Vous pouvez également écrire votre propre classe TypeScript pour explorer l'outil.

Page d'accueil de ChiselNow

Prenons l'exemple du template fourni : URL Shortener.
Cliquez sur l'option URL Shortener et vous pourrez voir le modèle dans l'éditeur de code.

  • Le modèle a un nom de classe par défaut et quelques propriétés. Pour ce tutoriel, nous allons les utiliser tels quels.
  • Acceptez les termes et conditions en cochant la case dans le coin gauche de l'éditeur.
  • Maintenant, dans la dernière étape, cliquez sur "Créez votre API maintenant". Il faudra environ 30 secondes pour créer une API et c'est tout.
  • Modèle de raccourcisseur d'URL pour la création de l'API CRUD
Une API CRUD entièrement fonctionnelle a été créée

Copiez le point de terminaison et la clé API dans votre système, car ils ne peuvent pas être récupérés une fois que vous quittez la page.

Exercer l'API

Une brève description des termes utilisés lors de l'utilisation des API.

  • Point de terminaison : cette URL sera utilisée pour effectuer des requêtes HTTP sur l'API générée, et vous développerez cela avec des paramètres de chaîne de requête.
  • Clé API : la clé API est utilisée pour l'autorisation et doit être fournie dans chaque requête dans l'en-tête HTTP X-Token.
  • Commandes CURL : il s'agit d'une collection d'exemples de commandes que vous pouvez utiliser pour lire et écrire des données d'entité.

La méthode POST : Elle permet d'ajouter des entités à la Base.

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 : Il est utilisé pour interroger chaque entité.

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"
      }
   ]
}

La méthode DELETE : Elle permet de supprimer toutes les entités du projet. Rappelez-vous, cela ne peut pas être annulé.

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”

Production:

{“results”:[]}

Le projet comporte certaines limites : outre les limites de stockage et de bande passante, il est automatiquement supprimé en deux jours. Pour continuer à utiliser votre API, en conservant les données que vous avez générées, vous pouvez importer le projet dans la plateforme ChiselStrike.

Façons d'importer le projet

Il existe deux manières d'importer le projet :

Depuis l'écran ChiselNow
Pour importer l'application, cliquez sur le bouton "Importer" à droite.

Importation du projet depuis l'écran ChiselNow

Connectez-vous avec votre compte GitHub.

Connectez-vous avec votre compte GitHub

ChiselStrike vous demandera de donner la permission de lire et d'écrire des référentiels. Cliquez sur "Autoriser ChiselStrike" pour donner la permission.

Autorisation de lire et d'écrire des référentiels

Maintenant, cliquez sur "Créer un référentiel Git vide", ce qui vous amènera à créer un nouveau référentiel sur GitHub. Une fois le référentiel créé.

Remplissez les champs avec votre nom d'utilisateur Github, le nom du référentiel et le nom du projet respectivement.

Cliquez sur "Continuer" et c'est fait !

Importation du projet

Maintenant, vous avez le lien du projet en direct, les itinéraires et toutes les autres informations sur le projet sur ChiselStrike.

Lien et itinéraires du projet en direct

Depuis la plateforme ChiselStrike

Si vous avez déjà un compte ChiselStrike, accédez au tableau de bord ChiselStrike. Cliquez sur "Nouveau projet".

Tableau de bord ChiselStrike

Maintenant, cliquez sur "Importer le projet ChiselNow".

Importation du projet ChiselNow

Semblable à la méthode précédente, vous devrez créer un nouveau référentiel GitHub et donner accès à ChiselStrike.

Remplissez les champs avec votre nom d'utilisateur Github, le nom du référentiel, le nom du projet, l'URL du point de terminaison et la clé API qui vous ont été fournis lors de la création du projet. Vous en aurez besoin ici.

Cliquez sur "Continuer" et c'est fait !

Remplir l'URL du point de terminaison et la clé API que vous avez enregistrées précédemment

Le projet a également été poussé vers votre référentiel GitHub. Tout est automatiquement importé dans les référentiels GitHub, y compris les routes, les modèles et les politiques. Vous pouvez également en savoir plus sur ce que vous pouvez faire d'autre avec ChiselStrike en consultant la documentation .

Code de projet poussé dans le référentiel GitHub

Félicitations, vous avez maintenant un projet entièrement fonctionnel avec ChiselNow. Vous pouvez accéder à votre GitHub, ajouter plus de fonctionnalités, écrire du code Backend, modifier les modèles, etc. Vous pouvez voir que le code a été poussé vers votre référentiel GitHub.

Dans les modèles, vous pouvez voir qu'il existe trois propriétés : URL d'origine, URL raccourcie et date d'expiration. Vous pouvez modifier le nom des propriétés ou leur type et réécrire les modèles en fonction du projet. Parcourez la documentation pour en savoir plus à ce sujet.

Codification des modèles

Les routes sont l'endroit où vous définissez vos points de terminaison. Vous pouvez parcourir la documentation pour en savoir plus à ce sujet.

Code des itinéraires

Pour créer un backend plus complexe et mettre votre prototype en production, consultez notre page de documentation .

Faites-nous savoir si vous créez quelque chose de cool en utilisant ChiselStrike ou ChiselNow sur notre Discord ou Twitter .