API Blueprint | API Blueprint
API Blueprint. Potężny, wysokopoziomowy język opisu API dla web API.
API Blueprint jest prosty i dostępny dla każdego, kto jest zaangażowany w cykl życia API. Jego składnia jest zwięzła, ale ekspresyjna. Dzięki API Blueprint możesz szybko projektować i prototypować interfejsy API, które dopiero powstaną, lub dokumentować i testować już wdrożone interfejsy API o znaczeniu krytycznym.
Dział Narzędzia samouczka
# GET /message+ Response 200 (text/plain) Hello World!Zorientowany na współpracę
API Blueprint jest zbudowany tak, aby zachęcać do dialogu i współpracy między interesariuszami projektu, programistami i klientami w każdym punkcie cyklu życia API. Jednocześnie narzędzia API Blueprint zapewniają wsparcie w osiąganiu celów, niezależnie od tego, czy chodzi o rozwój API, zarządzanie czy dostarczanie.
Open
API Blueprint jest całkowicie otwartym źródłem na licencji MIT.Jego przyszłość jest przejrzysta i otwarta.API Blueprint nie potrzebuje zamkniętej grupy roboczej. Zamiast tego używa procesu RFC podobnego do procesów RFC języka Rust lub Django Enhancement Proposal RFC.
Aby wnieść swój wkład, prześlij propozycję do repozytorium API Blueprint RFC.
W domu na GitHubie
Język API Blueprint jest rozpoznawany przez GitHub.Wyszukaj API Blueprint na GitHubie za pomocą zapytanialanguage:"API Blueprint".
Typem mediów dla API Blueprint jest text/vnd.apiblueprint, a standardowe rozszerzenie pliku to .apib. Jeśli użyjesz tego rozszerzenia, twoje projekty na GitHubie będą miały podświetloną składnię.
Zbudowany dla lepszych projektów API
API Blueprint jest zbudowany, aby zachęcić do lepszych projektów API poprzez abstrakcję.Celem API Blueprint jest odłączenie elementów API, aby umożliwić modularność w czasie enkapsulacji zachowania implementacji backendu.
Na przykład, najpierw wymodeluj swoje dane używając składni opisu danych.
# Data Structures## Blog Post (object)+ id: 42 (number, required)+ text: Hello World (string)+ author (Author) - Author of the blog post.## Author (object)+ name: Boba Fett+ email: [email protected]Potem, użyj i ponownie wykorzystaj dane w swoich punktach końcowych API.
# Blog Posts ## Retrieve All Posts + Response 200 (application/json) + Attributes (array)Design-first
API Blueprint jest w całości poświęcony filozofii design-first. Podobnie jak w przypadku testów intest-driven development, API Blueprint reprezentuje kontrakt dla API.Omówienie API i ustalenie kontraktu przed jego stworzeniem prowadzi do lepszych projektów API.
Po wprowadzeniu API Blueprint każdy może przetestować, czy implementacja spełnia oczekiwania określone w kontrakcie.
Niesamowite narzędzia
Dzięki jego szerokiemu przyjęciu istnieje mnóstwo narzędzi zbudowanych dla API Blueprint.Od różnych samodzielnych narzędzi, takich jak mock server, narzędzia do dokumentacji i testowania do w pełni funkcjonalnych rozwiązań cyklu życia API.
Zobacz sekcję Tools, aby uzyskać listę.
Getting Started
Aby rozpocząć pracę z API Blueprint, będziesz potrzebował edytora zwykłego tekstu. Aby uzyskać najlepsze wrażenia z edycji, przełącz podświetlanie składni na Markdown lub bezpośrednio na API Blueprint (jeśli edytor obsługuje tę funkcję).
Z gotowym edytorem podążaj za samouczkiem API Blueprint.
Po napisaniu pierwszego API Blueprint możesz przedyskutować projekt API z przyjaciółmi i użyć narzędzi API Blueprint. Na przykład, aby wyrenderować dokumentację, wygenerować makietę swojej usługi lub rozpocząć testowanie implementacji swojego backendu.