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

Update README.md

Browse Source
This commit is contained in:
Aleksei Akimov
2017-12-14 09:59:13 +01:00
committed by GitHub
parent 1b431b9fd9
commit e8c613a273
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -1,12 +1,12 @@
# Adyen OpenAPI / Swagger specifications
Adyen provides you with [plenty of different APIs](https://docs.adyen.com/developers) that help you accept payments on your website or mobile application, implement subscription billing, make payouts, and much more.
Adyen provides [various APIs](https://docs.adyen.com/developers) 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 standard](https://www.openapis.org/) (former Swagger specification).
This repository contains Adyen API specifications, represented in the [OpenAPI standard](https://www.openapis.org/) (formerly known as Swagger Specification).
## Folder structure
All specifications in this repository are organized into two subfolders:
Specifications in this repository are organized into two subfolders:
```
/specs
@@ -14,7 +14,7 @@ All specifications in this repository are organized into two subfolders:
/3.0 – Spec files in the OpenAPI 3.0.0 format.
```
We provide specifications in both `.json` and `.yaml` formats, with an API version number (e.g. `v30`) in a file name.
We provide specifications in both `.json` and `.yaml` formats, with the API version number (e.g. `v30`) in the file name.
## Usage
@@ -23,9 +23,9 @@ There are multiple ways you can use the OpenAPI specification to explore the Ady
- 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.
## Custom extensions
## Vendor extensions
Adyen specifications contain a few custom extensions, which are [allowed by the OpenAPI standard](https://swagger.io/docs/specification/openapi-extensions/). These extensions are used to provide metadata about API objects, for instance, to set grouping and sort order when displaying them in the [Adyen API Explorer](https://docs.adyen.com/api-explorer/).
Adyen's specifications contain some custom extensions, as [allowed by the OpenAPI standard](https://swagger.io/docs/specification/openapi-extensions/). These are annotations 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/).
For example: