Convert Swagger JSON to RAML/YAML

Question

How do I convert Swagger JSON to RAML/YAML and validate it? I am not looking for a programmatic way, just a one off conversion.

this one too https://github.com/essuraj/swagger-toolbox - https://swagger-toolbox.firebaseapp.com/ — Paolo, Oct 08 '19 at 18:05

helios · Answer 1 · 2015-09-23T03:01:10.923

53

Here are the steps:

Export Swagger JSON into a file on your drive. This JSON should be published on your server at the following URI: /swagger/docs/v1
Go to http://editor.swagger.io/#/
On the top left corner, select File-> Import File... Point to the local Swagger JSON file you exported in step #1 to open in the Swagger Editor
Select Generate Client -> Swagger YAML option from the menu
It will generate the YAML that you can validate at http://www.yamllint.com/ site

edited Sep 23 '15 at 03:01

answered Sep 23 '15 at 02:55

helios

2,603
4
21
26

6

I don't think that's what the question was about, this generates Swagger YAML, not RAML YAML. – coding Aug 24 '16 at 17:22
This does not answer the question but the actual solution can be found using almost the same way - Find my answer below. – Nikhil Nanjappa Oct 23 '17 at 11:33

score 8 · Answer 2 · answered Oct 23 '17 at 11:42

Its actually pretty simple

Web version of swagger editor gives the flexibility to import your existing swagger file(JSON/YAML) and download the configuration file that is currently being shown. So just combine these two.

Note: Converting JSON to YAML exists, but not JSON to RAML

First import your swagger JSON at http://editor.swagger.io/#/ (File > Import File)
Once you see your configurations, just download the corresponding YAML version (File > Download YAML).

The YAML version of the JSON you just uploaded will be downloaded.

score 6 · Answer 3 · answered Dec 06 '16 at 14:53

6

To convert API spec between various formats (e.g. Swagger/OpenAPI, RAML, Postman, etc), you can use the following free and open source tools:

answered Dec 06 '16 at 14:53

William Cheng

10,137
5
54
79

score 4 · Answer 4 · edited Oct 24 '16 at 04:48

Conversion

If you are looking to convert from any version Swagger to RAML 0.8 then APITransformer.com can do it for you. We're almost done with RAML 1.0 export. Will release it in a week's time.

Validation

The converted description comes out of the same code-gen engine that APIMatic uses to validate an API description before generating SDKs/Client libraries. Therefore, the converted RAML will be validated by default.

API descriptions in a variety of formats can also be validated via APIMatic's CLI or APIMatic's API

score 0 · Answer 5 · answered Aug 24 '16 at 17:32

0

While I wish there was a command line tool, this company has made a converter it seems:

https://apitransformer.com/

answered Aug 24 '16 at 17:32

coding

645
6
7

2

There is a command line tool for conversions as well. Its located at https://github.com/apimatic/apimatic-cli – Waseem Hassan Oct 24 '16 at 04:29
The link https://apimatic.io/transformer actually works and doing the same with their apimatic-cli seems to be tricky. Would you have an out-of-the-box guide? – gronaz Nov 21 '17 at 16:12

Convert Swagger JSON to RAML/YAML

5 Answers5

Linked