Innovations & Integrations (Community of Practice)

Thursday, 11 November 2021

Swagger.io

Application Programming Interface (API
"API is a software intermediary that allows two applications to talk to each other, as if 'the waiter' that brings data to connect different software platforms" to find out more...

“APIs are sets of requirements that govern how one application can communicate and interact with another. APIs can also allow developers to access certain internal functions of a program, although this is not typically the case for web APIsIn the simplest terms, an API allows one piece of software to interact with another piece of software, whether within a single computer via a mechanism provided by the operating system or over an internal or external TCP/IP-based or non-TCP/IP-based network.

Currently, many APIs are provided by organizations for access with HTTPAPIs may be used by both developers inside the organisation that published the API or by any developers outside that organisation who wish to register for access to the interface.” to find out more...

Open API
"An open API (often referred to as a public API) is a publicly available application programming interface that provides developers with programmatic access to a proprietary software application or web service." to find out more...

OpenAPI Specification (OAS)
OAS defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.

An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases. to find out more...

Swagger Tools
The Swagger tools were developed by the team behind the original "Swagger" Specification. 
Swagger offers the most powerful and easiest to use tools to take full advantage of the OpenAPI Specification. to find out more...


REST - Representational State Transfer. to find out more...
An architectural style for providing standards between computer systems on the web, making it easier for systems to communicate with each other. 

RESTful - REST-compliant systems 
RESTful systems are characterized by how they are stateless and separate the concerns of client and server. to find out more...

RESTful Architectural Constraints
  1. Uniform interface
  2. Client–server
  3. Stateless
  4. Cacheable
  5. Layered system
  6. Code on demand (optional)

HTTP Hypertext Transfer Protocol. 
An application-layer protocol for transmitting hypermedia documents, such as HTML. It was designed for communication between web browsers and web servers, but it can also be used for other purposes. to find out more...

HTML HyperText Markup Language
HTML is the standard markup language for documents designed to be displayed in a web browser. It can be assisted by technologies such as Cascading Style Sheets and scripting languages such as JavaScript. to find out more...

URI - Uniform Resource Identifier
A unique sequence of characters that identifies a logical or physical resource used by web technologies. URIs may be used to identify anything, including real-world objects, such as people and places, concepts, or information resources such as web pages and books. to find out more...

URL - Uniform Resource Locator
A form of URI and standardized naming convention for addressing documents accessible over the Internet and Intranet. The URL makes it possible for a computer to locate and open a web page on a different computer on the Internet. An example of a URL is https://www.computerhope.com, which is the URL for the Computer Hope website. to find out more...

Source:
  1. https://www.mulesoft.com/resources/api/what-is-an-api 
  2. https://en.wikipedia.org/wiki/Open_API
  3. https://swagger.io/specification/
  4. https://github.com/OAI/OpenAPI-Specification
  5. https://codewords.recurse.com/issues/five/what-restful-actually-means
  6. https://www.codecademy.com/articles/what-is-rest
  7. https://restfulapi.net/
  8. https://blog.ndepend.com/rest-vs-restful/
  9. https://developer.mozilla.org/en-US/docs/Web/HTTP
  10. https://en.wikipedia.org/wiki/HTML
  11. https://en.wikipedia.org/wiki/Uniform_Resource_Identifier
  12. https://www.techtarget.com/searchnetworking/definition/URL
  13. https://www.computerhope.com/jargon/u/url.htm

No comments:

Post a Comment