Översikt över RESTful API-beskrivningsspråk
RESTful (representational state transfer) API (applikationsprogrammeringsgränssnitt) DL:er (beskrivningsspråk) är formella språk utformade för att ge en strukturerad beskrivning av ett RESTful webb-API som är användbart både för en människa och för automatiserad maskinbearbetning. API-beskrivningsspråk kallas ibland för gränssnittsbeskrivningsspråk (IDL). Den strukturerade beskrivningen kan användas för att generera dokumentation för mänskliga programmerare ; sådan dokumentation kan vara lättare att läsa än fritt format, eftersom all dokumentation som genereras av samma verktyg följer samma formateringskonventioner. Dessutom är beskrivningsspråket vanligtvis tillräckligt exakt för att tillåta automatiserad generering av olika programvaruartefakter, som bibliotek, för att komma åt API:t från olika programmeringsspråk, vilket tar bördan av att manuellt skapa dem från programmerarna.
Historia
Det finns två tidigare stora beskrivningsspråk: WSDL2.0 (Web Services Description Language) och WADL (Web Application Description Language). Ingendera är allmänt antagen i branschen för att beskriva RESTful API:er, med hänvisning till dålig mänsklig läsbarhet för båda och att WADL faktiskt inte kan beskriva ett RESTful API.
Princip
Hypertextdrivet API
Principen bakom att bygga RESTful APIs är känd under akronymen HATEOAS ( Hypermedia as the Engine of Application State) . I detta tillvägagångssätt skrivs inte klientprogramvaran till en statisk gränssnittsbeskrivning som delas genom dokumentation. Istället ges klienten en uppsättning ingångspunkter och API:t upptäcks dynamiskt genom interaktion med dessa slutpunkter. HATEOAS introducerades i Roy Fieldings doktorsavhandling Architectural Styles and the Design of Network-based Software Architectures . HATEOAS är ett av nyckelelementen som skiljer REST från RPC- mekanismer.
Lista över RESTful API DLs
- Web Services Description Language (WSDL)
- Hydra
- Open Data Protocol (OData)