Package org.ctan.site.resources.content

Class Markdown3Resource

java.lang.Object

org.ctan.site.resources.content.Markdown3Resource

@Path("/3.0/markdown")
@Produces("application/json")
public class Markdown3Resource
extends Object

The class Markdown3Resource contains the controller for the Markdown renderer resource.

Constructor Summary

Constructors

Constructor	Description
Markdown3Resource()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getVersion()	The method getVersion provides means to retrieve the version number of the API.
String	render(@NonNull String text)	The method render provides means to translate a markdown text to HTML.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Markdown3Resource

public Markdown3Resource()

Method Details

getVersion

@GET
@Path("/version")
public Map<String,String> getVersion()

The method getVersion provides means to retrieve the version number of the API.

Returns:

a Map with a single attribute version containing the version number as String.

render

@POST
@PermitAll
@Path("/render")
public String render(@NonNull
 @NonNull String text)

The method render provides means to translate a markdown text to HTML.

Parameters:

text - the text to expand

Returns:

the generated HTML