Raml to HTML conversion


#1

Hello ,

I am new to RAML , i am trying to convert RAML to HTML, i found Java Converter. My raml file structure is as follows, when i convert to HTML my response JSON data display as a string. Could you anyone suggest how to overcome it?

#%RAML 0.8

title: "Tax service"
version: v1
schemas:

  • postquote: |
    {

    }

/quote:

post:
description: Post a tax quotation.
body:
application/json:
schema: postquote
responses:
500:
body:
application/json:
schema : |
{ “$schema”: “http://json-schema.org/draft-04/schema#”,
“title”: “error”,
“description”: “schema for API specified errors”,
“type”: “object”,
“properties”: {
“status” : {
“type” : “integer”,
“description” : “original HTTP error code, should be consistent with the response HTTP code”,
“minimum” : 100,
“maximum” : 599
},
“type” : {
“type” : “string”,
“description” : “classification of the error type, lower case with underscore eg validation_failure”,
“pattern” : “[a-z]+[a-z_][a-z]+"
},
“message” : {
“type” : “string”,
“description” : “descriptive error message for debugging”
},
“moreInfo” : {
“type” : “string”,
“format” : “uri”,
“description” : “link to documentation to investigate further and finding support”
},
“details” : {
“type” : “array”,
“description” : “list of problems causing this error”,
“items” : {
"$schema" : “http://json-schema.org/draft-04/schema#”,
“title” : “errorDetail”,
“description” : “schema for specific error cause”,
“type” : “object”,
“properties” : {
“field” : {
“type” : “string”,
“description” : “a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific”
},
“type” : {
“type” : “string”,
“description” : “classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.”,
“pattern” : "[a-z]+[a-z_]
[a-z]+”
},
“message” : {
“type” : “string”,
“description” : “descriptive error detail message for debugging”
},
“moreInfo” : {
“type” : “string”,
“format” : “uri”,
“description” : “link to documentation to investigate further and finding support for error detail”
}
},
“required” : [ “type” ]
}
}
},
“required” : [ “status”, “type” ]
}


#2

Hi @Rakesh,

welcome to the RAML world :wink: If you are using 0.8 you should try out either raml2html or php-raml2html.

Let me know if that is enough for you!

Christian


#3

Looking for a replacement for raml2html tool : - Ramlo API documentation


It supports RAML 1.0


#4

Ramlo is also very cool, but still in development. So carefully. Its seems that it will be finished by end of October looking at their milestones.