Web-Md-Converter

Web-Md-Converter is a web interface or REST APIS for converting a markdown to another format using pandoc. This includes a templates manager.

Version information

Tested on ruby 2.1.0, 2.2.0, 2.3.0
Using pandoc 1.17.0.3 in our development environment

Web Interface

Installation:

$ git clone [email protected]:eshamster/web_md_converter.git
$ cd web_md_converter
$ bundle install

Start the server:

$ ruby web_md_converter.rb

You can access the web interface by http://localhost:4567 via a browser

API

In all APIs, if some parameters are lack, the status 400 is returned with such a message as the following.

HTTP/1.1 400 Bad Request 
Content-Type: text/html;charset=utf-8

Some required parameters are lack: Required = [:file, :output_type]

/convert

POST

Convert a markdown file to the specfied format (with a template if needed)

Name	Required?	Type	Description
file	true	file object	The markdown file (multipart/form-data)
output_type	true	string	The format name. Valid format names are gotten by the API 'GET /types'
template	false	string	The name of a registered template file. Valid names are gotten by the API 'GET /templates/lists'

Normal response:

$ curl -i -F "file=@./README.md" -F "output_type=html" -F "template=sample.css" http://$address/convert
HTTP/1.1 200 OK
Content-Type: text/html;charset=utf-8

<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <meta name="generator" content="pandoc">
  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
  <title></title>
  ...
  ...

Error responses:

status 400
- With not supported output_type
- (TODO: With not exist template name)

/templates/lists

GET

Get lists of templates. Keys and values of the return value by this API are used in other APIs.

A key: 'output_type' or 'type'
An element of the values (= array): 'template' or 'name'

Name	Required?	Type	Description
-	-	-	-

Notes: There are no arguments

Normal response:

$ curl -i http://$address/templates/lists
HTTP/1.1 200 OK 
Content-Type: application/json

{
  "word": ["test2.dotx", "test1.dotx"],
  "html": ["test3.css", "test2.css", "test1.css"]
}

/templates

Manage template files for various formats

GET

Get a template file

Name	Required?	Type	Description
type	true	string	The format name. (Ex. html, word)
name	true	string	The name of a registered template file.

Normal response:

$ curl -i "http://$address/templates?type=html&name=sample.css"
HTTP/1.1 200 OK
Content-Type: text/css;charset=utf-8

h1 {
    text-decoration: underline;
}

table {
    border: 2px double black;
    border-collapse: collapse;
}
...
...

Error responses:

status 400
- With not supported type
- With not exist name

POST

Post a new template file.

Name	Required?	Type	Description
file	true	file object	The template file (multipart/form-data)
type	true	string	The format name. (Ex. html, word)
name	true	string	The name for register.

Normal response:

$ curl -i -F "file=@./temp.css" -F "type=html" -F "name=some_name.css" http://$address/templates
HTTP/1.1 200 OK
Content-Type: application/json

{"type":"html","name":"some_name.css"}

Error responses:

status 400
- With not supported type
- With already registred name in the type

DELETE

Delete a template file

Name	Required?	Type	Description
type	true	string	The format name. (Ex. html, word)
name	true	string	The name of a registered template file.

Normal response:

$ curl -i -X DELETE -F "type=html" -F "name=some_name.css" http://$address/templates
HTTP/1.1 200 OK
Content-Type: application/json

{"type":"html","name":"some_name.css"}

Error responses:

status 400
- With not supported type
- With not exist name

/types

GET

Get information of all supported types

Name	Required?	Type	Description
-	-	-	-

Notes: There are no arguments

Normal response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "html": {
    "content_type": "text/html",
    "specifier": "html",
    "template_content_type": "text/css"
  },
  "word": {
    "content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "specifier": "docx",
    "template_content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.template"
  }
}

License

Licensed under the MIT License.

eshamster / web_md_converter Goto Github PK

web_md_converter's Introduction

Web-Md-Converter

Version information

Web Interface

API

/convert

POST

/templates/lists

GET

/templates

GET

POST

DELETE

/types

GET

License

web_md_converter's People

Contributors

Watchers

Recommend Projects

Recommend Topics

Recommend Org