From 8622a705e312b995ca4bc10f65561000f7ae1cb1 Mon Sep 17 00:00:00 2001 From: Inaki Fernandez Date: Sat, 9 May 2020 16:24:04 +0200 Subject: [PATCH] reorganization --- docs/api.md | 5 +++-- docs/index.md | 6 +++--- mkdocs.yml | 4 ++-- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/api.md b/docs/api.md index 846d01df..71828208 100644 --- a/docs/api.md +++ b/docs/api.md @@ -3,7 +3,7 @@ - [Types of API Protocols](#types-of-api-protocols) - [SOAP API Protocol (Simple Object Access Protocol)](#soap-api-protocol-simple-object-access-protocol) - [REST API Protocol (Representational State Transfer)](#rest-api-protocol-representational-state-transfer) - - [OpenAPI/Swagger](#openapiswagger) + - [OpenAPI Specification (originally known as the Swagger Specification)](#openapi-specification-originally-known-as-the-swagger-specification) - [RPC API Protocol (Remote Procedure Call)](#rpc-api-protocol-remote-procedure-call) - [gRPC](#grpc) - [Comparisons](#comparisons) @@ -42,8 +42,9 @@ - [Dzone refcard: Foundations of **RESTful Architecture** ๐ŸŒŸ](https://dzone.com/refcardz/rest-foundations-restful) - [Dzone: REST API tutorials](https://dzone.com/articles/rest-api-tutorials) -#### OpenAPI/Swagger +#### OpenAPI Specification (originally known as the Swagger Specification) - [OpenAPI](https://www.openapis.org/) evolved from the [Swagger](https://swagger.io/) project. Swagger started out as a specification for documenting RESTful APIs. Later on, tools to generate client and server code and generating of test cases were added. While the original Swagger Specification was donated to the Linux Foundation and renamed the OpenAPI, Swagger remains one of the most widely used open-source toolsets for developing OpenAPIs. +- [Wikipedia: OpenAPI Specification ๐ŸŒŸ](https://en.wikipedia.org/wiki/OpenAPI_Specification) - [OpenAPI FAQ. What is OpenAPI Specification (OAS)? OpenAPI Specification](https://www.openapis.org/faq) The OAS defines a standard, programming language-agnostic interface description for REST APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic. - [apis.guru/openapi-directory: large archive of sample OpenAPI descriptions](https://apis.guru/openapi-directory/) diff --git a/docs/index.md b/docs/index.md index 2caf9dba..19b18b55 100644 --- a/docs/index.md +++ b/docs/index.md @@ -104,11 +104,11 @@ Microservices architectures rely on DevOps practices, automation, CI/CD (continu - [Python - Django & Flask](python.md) - [Serverless Architectures & Frameworks](serverless.md) - [Xamarin](xamarin.md) -19. - [APIs with SOAP, REST and gRPC](api.md) +19. [APIs with SOAP, REST and gRPC](api.md) + - [Swagger code generator for REST APIs](swagger-code-generator-for-rest-apis.md) + - [Test Automation with Postman](postman.md) - [API Marketplaces and Developer Portals๐ŸŒŸ](developerportals.md) - [3scale API Management](3scale.md) - - [Swagger code generator for REST APIs](swagger-code-generator-for-rest-apis.md) - - [Test Automation with Postman](postman.md) 20. [Demos](demos.md) 21. Public Cloud - [Public Cloud Solutions](public-cloud-solutions.md) diff --git a/mkdocs.yml b/mkdocs.yml index 5d487167..1a587b28 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -101,10 +101,10 @@ pages: - Xamarin: xamarin.md - APIs: - APIs with SOAP, REST and gRPC: api.md + - Swagger code generator for REST APIs: swagger-code-generator-for-rest-apis.md + - Test Automation with Postman: postman.md - API Marketplaces and Developer Portals: developerportals.md - 3scale API Management: 3scale.md - - Test Automation with Postman: postman.md - - Swagger code generator for REST APIs: swagger-code-generator-for-rest-apis.md - TestOps: testops.md - Demos: demos.md - Public Cloud: