jlengrand/adyen-openapi
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-openapi.git synced 2026-03-10 08:01:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use proper terminology to refer to OpenAPI files as API definitions

Browse Source
This commit is contained in:
aleksei
2020-03-04 09:51:44 +01:00
parent d24b826e3f
commit d78024e1f2
93 changed files with 10 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -1,31 +1,30 @@
# Adyen OpenAPI / Swagger specifications
# Adyen OpenAPI / Swagger definitions
Adyen provides [various APIs](https://docs.adyen.com) to help you accept payments on your website or mobile application, implement subscription billing, make payouts, and much more.
This repository contains Adyen API specifications, represented in the [OpenAPI Specification](https://www.openapis.org/) standard (formerly known as Swagger Specification).
This repository contains Adyen API definition files, represented in the [OpenAPI Specification](https://www.openapis.org/) standard (formerly known as Swagger Specification).
## Folder structure
Specifications in this repository are organized into two subfolders:
API definitions in this repository are organized into two subfolders:
```
/specs
/json – Spec files in the json format.
/yaml – Spec files in the yaml format.
/json – Definition files in the json format.
/yaml – Definition files in the yaml format.
```
We support the OpenAPI version 3.0.0.
## Usage
There are multiple ways you can use the OpenAPI specification to explore the Adyen API:
- If you want to see the OpenAPI specification in action, visit the [Adyen API Explorer](https://docs.adyen.com/api-explorer/) portal.
- If you prefer to use the classic Swagger toolset, upload these specifications to the [Swagger Editor](http://editor.swagger.io/) or [SwaggerHub](https://swaggerhub.com/).
- Also we recommend you use [Postman](https://www.getpostman.com/postman) to import the OpenAPI specification and create your personal collection of requests.
There are multiple ways you can use the OpenAPI definition to explore the Adyen API:
- If you want to see the API definitions in action, visit the [Adyen API Explorer](https://docs.adyen.com/api-explorer/) portal.
- If you prefer to use the classic Swagger toolset, upload these definitions to the [Swagger Editor](http://editor.swagger.io/) or [SwaggerHub](https://swaggerhub.com/).
- Also we recommend you use [Postman](https://www.getpostman.com/postman) to import the API definition and create your personal collection of requests.
## Vendor extensions
Adyen's specifications contain some custom extensions, as [allowed by the OpenAPI standard](https://swagger.io/docs/specification/openapi-extensions/). These are extensions that provide metadata, such as the grouping and sort order of API objects, when they are displayed in the [Adyen API Explorer](https://docs.adyen.com/api-explorer/).
Adyen's API definitions contain some custom extensions, as [allowed by the OpenAPI standard](https://swagger.io/docs/specification/openapi-extensions/). These are extensions that provide metadata, such as the grouping and sort order of API objects, when they are displayed in the [Adyen API Explorer](https://docs.adyen.com/api-explorer/).
### x-groups