ChiselNow: Uzyskaj w pełni funkcjonalny interfejs CRUD API w ciągu kilku minut

Nov 29 2022
Najszybszy i najłatwiejszy sposób na stworzenie pełnego CRUD API. Nie sądzę, żeby było do tego coś lepszego niż ChiselNow.
Tworzenie backendu jest czasochłonne i stosunkowo trudniejsze dla programistów frontendowych. Nawet jeśli używasz narzędzia do automatyzacji backendu, musisz napisać kilka skryptów, stworzyć punkty końcowe, modele itp.

Tworzenie backendu jest czasochłonne i stosunkowo trudniejsze dla programistów frontendowych. Nawet jeśli używasz narzędzia do automatyzacji backendu, musisz napisać kilka skryptów, stworzyć punkty końcowe, modele itp.

Aby pomóc programistom zrobić to samo, uruchomiliśmy ChiselNow , najkrótszą drogę do w pełni funkcjonalnego zaplecza w ciągu kilku minut.

Po prostu zbuduj frontend, zdefiniuj swój model w TypeScript i uzyskaj pełne API REST gotowe do pracy za pomocą kilku kliknięć. Nie jest wymagana rejestracja ani karta kredytowa, rozpoczęcie nic nie kosztuje.

Przejdźmy dalej i nauczmy się tworzyć w pełni funkcjonalne interfejsy API CRUD za pomocą ChiselNow.

Budowanie API CRUD

Przejdź do ChiselNow i przewiń trochę w dół. Istnieje kilka przykładów szablonów sugerujących różne rodzaje przypadków użycia obsługiwanych przez ChiselNow. Możesz także napisać własną klasę TypeScript, aby poznać narzędzie.

Strona główna ChiselNow

Weźmy na przykład dostarczony szablon: URL Shortener.
Kliknij opcję URL Shortener, a zobaczysz szablon w edytorze kodu.

  • Szablon ma domyślną nazwę klasy i kilka właściwości. W tym samouczku użyjemy ich w obecnej postaci.
  • Zaakceptuj regulamin zaznaczając pole w lewym rogu edytora.
  • Teraz, w ostatnim kroku, kliknij „Utwórz teraz swój interfejs API”. Utworzenie interfejsu API zajmie około 30 sekund i to wszystko.
  • Szablon URL Shortener do tworzenia CRUD API
Powstało w pełni funkcjonalne CRUD API

Skopiuj punkt końcowy i klucz API do swojego systemu, ponieważ nie można ich odzyskać po opuszczeniu strony.

Ćwiczenie API

Krótki opis terminów używanych podczas pracy z interfejsami API.

  • Punkt końcowy: ten adres URL będzie używany do wysyłania żądań HTTP w stosunku do wygenerowanego interfejsu API, który zostanie rozszerzony o parametry ciągu zapytania.
  • Klucz API: Klucz API służy do autoryzacji i musi być podany w każdym żądaniu w nagłówku HTTP X-Token.
  • Polecenia CURL: Jest to zbiór przykładowych poleceń, których można używać do odczytywania i zapisywania danych encji.

Metoda POST : Służy do dodawania podmiotów do bazy danych.

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 : Służy do zapytania o każdą jednostkę.

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

Metoda DELETE : służy do usuwania wszystkich elementów z projektu. Pamiętaj, że nie można tego cofnąć.

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”

Wyjście:

{“results”:[]}

Projekt ma pewne ograniczenia: poza limitami miejsca i przepustowości, jest automatycznie usuwany w ciągu dwóch dni. Aby nadal korzystać z interfejsu API, zachowując wygenerowane dane, możesz zaimportować projekt do platformy ChiselStrike.

Sposoby importu projektu

Istnieją dwa sposoby importu projektu:

Z ekranu ChiselNow
Aby zaimportować aplikację, kliknij przycisk „Importuj” po prawej stronie.

Importowanie projektu z ekranu ChiselNow

Zaloguj się za pomocą swojego konta GitHub.

Zaloguj się za pomocą swojego konta GitHub

ChiselStrike poprosi Cię o pozwolenie na odczyt i zapis repozytoriów. Kliknij „Autoryzuj ChiselStrike”, aby wyrazić zgodę.

Uprawnienia do odczytu i zapisu repozytoriów

Teraz kliknij „Utwórz puste repozytorium Git”, które zabierze Cię do utworzenia nowego repozytorium na GitHub. Po utworzeniu repozytorium.

Wypełnij pola odpowiednio swoją nazwą użytkownika Github, nazwą repozytorium i nazwą projektu.

Kliknij „Kontynuuj” i gotowe!

Importowanie projektu

Teraz masz link do projektu na żywo, trasy i wszystkie inne informacje o projekcie na ChiselStrike.

Link do projektu na żywo i trasy

Z platformy ChiselStrike

Jeśli masz już konto ChiselStrike, przejdź do pulpitu nawigacyjnego ChiselStrike. Kliknij „Nowy projekt”.

Deska rozdzielcza ChiselStrike

Teraz kliknij „Importuj projekt ChiselNow”.

Importowanie projektu ChiselNow

Podobnie jak w przypadku poprzedniej metody, będziesz musiał utworzyć nowe repozytorium GitHub i zapewnić dostęp do ChiselStrike.

Wypełnij pola swoją nazwą użytkownika Github, nazwą repozytorium, nazwą projektu, adresem URL punktu końcowego i kluczem API, które otrzymałeś podczas pierwszego tworzenia projektu. Będziesz tego potrzebował tutaj.

Kliknij „Kontynuuj” i gotowe!

Wypełnij adres URL punktu końcowego i klucz API, który zapisałeś wcześniej

Projekt został również przekazany do Twojego repozytorium GitHub. Wszystko jest automatycznie importowane do repozytoriów GitHub, w tym trasy, modele i zasady. Możesz także dowiedzieć się więcej o tym, co jeszcze można zrobić z ChiselStrike, sprawdzając dokumentację .

Kod projektu przekazany do repozytorium GitHub

Gratulacje, teraz masz w pełni funkcjonalny projekt z ChiselNow. Możesz przejść do swojego GitHuba, dodać więcej funkcji, napisać kod zaplecza, zmodyfikować modele itp. Możesz zobaczyć, że kod został wypchnięty do twojego repozytorium GitHub.

W modelach widać, że istnieją trzy właściwości: oryginalny adres URL, skrócony adres URL i data wygaśnięcia. Możesz zmienić nazwę właściwości lub ich typ i przepisać modele zgodnie z projektem. Przejrzyj dokumentację , aby dowiedzieć się więcej na ten temat.

Kod modeli

Trasy to miejsca, w których definiujesz punkty końcowe. Możesz przejrzeć dokumentację , aby dowiedzieć się więcej na ten temat.

Kod tras

Aby zbudować bardziej złożony backend i przenieść swój prototyp do produkcji, sprawdź naszą stronę z dokumentacją .

Daj nam znać, jeśli stworzysz coś fajnego za pomocą ChiselStrike lub ChiselNow na naszym Discordzie lub Twitterze .