Přehled RESTful API Popis Jazyky - Overview of RESTful API Description Languages

Klidný (přenos reprezentativního stavu) API (aplikační programovací rozhraní) DL (jazyky popisu) jsou formální jazyky navržen tak, aby poskytoval strukturovaný popis a Klidný webové rozhraní API to je užitečné jak pro člověka, tak pro automatizované strojové zpracování. API Popis Jazyky se někdy nazývají jazyky popisu rozhraní (IDL). Strukturovaný popis lze použít ke generování dokumentace pro člověka programátoři; taková dokumentace může být snadněji čitelná než dokumentace ve volném formátu, protože veškerá dokumentace vygenerovaná stejným nástrojem dodržuje stejné konvence formátování. Navíc je popisný jazyk obvykle dostatečně přesný, aby umožnil automatizovanému generování různých softwarových artefaktů, jako jsou knihovny, přístup k API z různých programovacích jazyků, což bere zátěž jejich ručního vytváření mimo programátory.

Dějiny

Existují dva předchozí hlavní jazyky popisu: WSDL2.0 (Jazyk popisu webových služeb) a WADL (Jazyk popisu webové aplikace). Ani v tomto odvětví není široce přijímán pro popis RESTful API, s odvoláním na špatnou lidskou čitelnost obou a WADL ve skutečnosti není schopen plně popsat RESTful API.[1]

Alternativy

Hypertextově řízená API

Alternativní přístup k vytváření RESTful API je znám pod zkratkou HATEOAS (Hypermedia jako motor stavu aplikace ). V tomto přístupu není klientský software zapsán do statického popisu rozhraní sdíleného prostřednictvím dokumentace. Místo toho je klientovi dána sada vstupních bodů a API je objeveno dynamicky prostřednictvím interakce s těmito koncovými body. HATEOAS byl představen v Roy Fielding disertační práce Architektonické styly a návrh síťových softwarových architektur. HATEOAS je původní vizí pro RESTful API, která je odlišuje od RPC mechanismy.[2]

Seznam RESTful API DL

Seznam jazyků popisu dat

Významnou součástí popisu RESTful API je specifikace vrácených datových struktur. IDL může buď zadat svůj vlastní formát, nebo použít existující formát popisu dat. Pozoruhodný příklad, který používá mnoho RESTful API DL Schéma JSON.

Porovnání RESTful API DLs

Komunita kolem RESTful API DL je aktivní a prostředí se stále mění. Podle prezentace Akany jsou nejaktivnějšími projekty v této oblasti OpenAPI, RAML a API Blueprint.[1]

SponzorPočáteční potvrzeníNejnovější stabilní vydáníStabilní datum vydáníSoftwarová licence[7]FormátOtevřený zdrojGenerování kódu (klient)Generování kódu (server)
RAMLMuleSoftZáří 20131.016. května 2016Apache 2.0YAMLAnoAnoAno
API BlueprintVčelínDuben 2013MITSníženíAnoNeNe
OpenAPIOpen API Initiative (OAI)Červenec 20113.026. července 2017Apache 2.0JSON nebo YAMLAnoAnoAno
SERINUNIFOR20112.0Prosince 2014Creative CommonsRDFAnoNeAno

Rámce

Mnoho serverových rámců spolupracuje s jedním nebo více IDL.

Reference

  1. ^ A b http://www.slideshare.net/SOA_Software/api-description-languages
  2. ^ Fielding, Roy. „REST APIs must be hypertext-driven“. Citováno 4. listopadu 2015.
  3. ^ „TC OASIS Open Data Protocol (OData) - OASIS“.
  4. ^ „Barrister RPC - About“.
  5. ^ Lira, Hermano Albuquerque; Dantas, Jose Renato Villela; Muniz, Bruno de Azevedo; Nunes, Tadeu Matos; Farias, Pedro Porfirio Muniz (01.01.2015). „Přístup k podpoře integrity dat pro webové služby pomocí sémantických rozhraní RESTful“. Sborník z 24. mezinárodní konference o World Wide Web. WWW '15 Companion. New York, NY, USA: ACM: 1485–1490. doi:10.1145/2740908.2743042. ISBN  9781450334730.
  6. ^ https://developers.google.com/discovery/v1/reference/apis
  7. ^ Licence zde představují souhrn a nepovažují se za úplná prohlášení o licencích. Některé balíčky mohou používat knihovny pod různými licencemi.

externí odkazy