DOI: https://doi.org/10.15407/pp2018.04.059

Modern restful api dls and frameworks for restful web services api schema modeling, documenting, visualizing

K.S. Malakhov, A.P. Kurgaev, V.Yu. Velychko

Abstract


The given paper presents an overview of modern RESTful API description languages (belongs to interface description languages set) – OpenAPI, RAML, WADL, Slate – designed to provide a structured description of a RESTful web APIs (that is useful both to a human and for automated machine processing), with related RESTful web API modelling frameworks. We propose an example of the schema model of web API of the service for pre-trained distributional semantic models (word embeddings) processing. This service is a part of the “Personal Research Information System” services ecosystem – the “Research and Development Workstation Environment” class system for supporting research in the field of ontology engineering: the automated building of applied ontology in an arbitrary domain area as a main feature; scientific and technical creativity: the automated preparation of application documents for patenting inventions in Ukraine. It also presents a quick look at the relationship of Service-Oriented Architecture and Web services as well as REST fundamentals and RESTful web services; RESTful API creation process.

Problems in programming 2018; 4: 59-68


Keywords


Service-Oriented Architecture; Web service; REST; RESTful API; OpenAPI; RAML; WADL; Slate

Full Text:

PDF

References


Palagin O.V., Velychko V.Yu., Malakhov K.S. and Shchurov O.S. Personal research information system. About developing the methods for searching patent analogs of invention. Computer means, networks and systems. 2017. N 16. P. 5–13. (in Ukrainian).

Palagin O.V., Velychko V.Yu., Malakhov K.S. and Shchurov O.S. (2018). Research and development workstation environment: the new class of current research information systems. Problems in programming. N 2–3. P. 289–298.

Open Group. Service Oriented Architecture: What is SOA? [Online] Available from: https://www.opengroup.org/soa/source-book/ soa/p1.htm [Accessed: 05.11.2018]

Mackenzie C.M., Laskey K., McCabe F., Brown P.F., Metz R. 2006. OASIS Reference Model for Service Oriented Architec-ture 1.0. OASIS. [Online] Available from: https://www.oasis-open.org/committees/ download.php/19679/soa-rm-cs.pdf [Accessed: 05.11.2018]

Chou D. Using Events in Highly Distributed Architectures. The Architecture Journal. [Online] Available from: https://msdn.microsoft. com/en-us/library/ dd129913.aspx [Accessed: 05.11.2018]

Bhowmik S. Cloud Computing. Cambridge University Press. 2017. 462 p.

Etzkorn L.H. Introduction to Middleware: Web Services, Object Components, and Cloud Computing. CRC Press, 2017. 662 p.

Barry D.K. Web Services, Service-Oriented Architectures, and Cloud Computing: The Savvy Manager's Guide. Morgan Kaufmann is an imprint of Elsevier, 2013. 248 p.

Fielding R. 2000. Architectural Styles and the Design of Network-Based Software Architectures. Ph.D. Dissertation, University of California-Irvine. [Online] Avaliable from: https://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm [accessed 05.11.2018]

Pereira C.R. Building APIs with Node.js. Apress, 2016. 135 p. CrossRef

Doglio F. REST API Development with Node.js. Apress, 2018. 323 p. CrossRef

Patni S. Pro RESTful APIs: Design, Build and Integrate with REST, JSON, XML and JAX-RS. Apress, 2017. 126 p. CrossRef

RESTful API Modeling Language (RAML). [Online] Available from: https://raml.org/ [Accessed: 05.11.2018]

RAML 100 Tutorial | RAML. [Online] Available from: https://raml.org/developers/raml-100-tutorial [Accessed: 05.11.2018]

API Design Tooling From RAML. [Online] Available from: http://apievangelist.com/2014/ 03/01/api-design-tooling-from-raml/ [Accessed: 05.11.2018]

Swagger (OAS) vs. RAML - Which is Better for Building APIs? [Online] Available from: https://blog.vsoftconsulting.com/blog/is-raml-or-swagger-better-for-building-apis [Accessed: 05.11.2018]

Anypoint Platform. [Online] Available from: https://anypoint.mulesoft.com/ [Accessed: 05.11.2018]

The Best APIs are Built with Swagger Tools | Swagger. [Online] Available from: https://swagger.io/ [Accessed: 05.11.2018]

OpenAPI Initiative Charter. [Online] Available from: https://www.openapis.org/participate/how-to-contribute/governance [Accessed: 05.11.2018]

Web Application Description Language. [Online] Available from: https://www.w3.org/ Submission/wadl/ [Accessed: 05.11.2018]

Lord/slate: Beautiful static documentation for your API. [Online] Available from: https://github.com/lord/slate [Accessed: 05.11.2018]

API Blueprint | API Blueprint. [Online] Available from: https://apiblueprint.org/ [Accessed: 05.11.2018]

Malakhovks/ds-rest-api. GitHub. [Online] Available from: https://github.com/mala-khovks/ds-rest-api [Accessed: 05.11.2018]




DOI: https://doi.org/10.15407/pp2018.04.059

Refbacks

  • There are currently no refbacks.