Package de.kosmos_lab.web.server

Class OpenApiParser

java.lang.Object

de.kosmos_lab.web.server.OpenApiParser

Direct Known Subclasses:

AsyncApiParser

public class OpenApiParser
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected org.slf4j.Logger	logger
HashSet<String>	missingFromResource
protected WebServer	server

Constructor Summary

Constructors

Constructor	Description
OpenApiParser(WebServer server)

Method Summary

Modifier and Type	Method	Description
void	add(Parameter p, org.json.JSONArray params)
void	add(Tag tag, org.json.JSONArray array)
void	add(ApiEndpoint endpoint, Operation operation, Method method, org.json.JSONObject paths)
void	add(String tag, boolean value, org.json.JSONObject json, Boolean ignoreIfThis)
void	add(String tag, double value, org.json.JSONObject json, Double ignoreIfThis)
void	add(String tag, int value, org.json.JSONObject json, Integer ignoreIfThis)
void	add(String tag, ExternalDocumentation value, org.json.JSONObject json)
void	add(String tag, Header[] value, org.json.JSONObject json)
void	add(String tag, Contact contact, org.json.JSONObject json)
void	add(String tag, License license, org.json.JSONObject json)
void	add(String tag, Content[] value, org.json.JSONObject json)
void	add(String tag, DiscriminatorMapping[] value, org.json.JSONObject json)
void	add(String tag, ExampleObject[] examples, org.json.JSONObject json)
void	add(String tag, SchemaProperty[] properties, org.json.JSONObject json)
void	add(String tag, Schema schema, org.json.JSONObject json)
void	add(String tag, OAuthFlow flow, org.json.JSONObject json)
void	add(String tag, OAuthFlows flows, org.json.JSONObject json)
void	add(String tag, Tag[] tags, org.json.JSONObject json)
void	add(String tag, Class<?>[] clzlist, org.json.JSONObject json)
void	add(String tag, Class<?> clz, org.json.JSONObject json)
void	add(String tag, String[] values, org.json.JSONObject json)
void	add(String tag, String value, org.json.JSONObject json)
void	add(String tag, String value, org.json.JSONObject json, boolean parseValue)
void	add(String tag, HashSet<Tag> tags, org.json.JSONObject json)
void	add(String tag, org.json.JSONArray values, org.json.JSONObject json)
void	add(String tag, org.json.JSONObject values, org.json.JSONObject json)
protected void	addException(String n, Class<?> ex, org.json.JSONObject resp)
String	asYaml(String jsonString)
boolean	checkExample(ExampleObject e, org.json.JSONObject schema, SchemaType type)
boolean	checkExample(String value, org.json.JSONObject schema, SchemaType type)
Tuple	checkExamples()	used to check if the examples are all correct
org.json.JSONObject	createJSONSchemaFromSchema(org.json.JSONObject schema)
HashMap<String,String>	extractExamples(Schema schema)
HashMap<String,String>	extractExamples(Parameter parameter)
HashMap<String,String>	extractExamples(String example, ExampleObject[] examples)
String	getCachedJSON()
String	getCachedYAML()
org.json.JSONArray	getExamplesArray(ExampleObject[] examples)
org.json.JSONArray	getExamplesArray(HashMap<String,String> examples)
org.json.JSONArray	getExamplesArray(List<ExampleObject> examples)
org.json.JSONObject	getExamplesObject(ExampleObject[] examples)
org.json.JSONObject	getExamplesObject(HashMap<String,String> examples)
org.json.JSONObject	getExamplesObject(List<ExampleObject> examples)
static OpenApiParser	getInstance(WebServer server)
org.json.JSONObject	getJSON()
Set<Class<? extends jakarta.servlet.http.HttpServlet>>	getServlets()
String	getStringFromResource(String name)
String	getYAML()
Object	parseValue(String value)
String	prepareString(String input)
org.json.JSONObject	toJSON(AsyncInfo info)
org.json.JSONObject	toJSON(Info info)
org.json.JSONObject	toJSON(ArraySchema arraySchema)
org.json.JSONObject	toJSON(ExampleObject example)
org.json.JSONObject	toJSON(ObjectSchema p)
org.json.JSONObject	toJSON(Schema schema)
org.json.JSONObject	toJSON(SchemaProperty[] properties)
org.json.JSONObject	toJSON(Parameter p)

Methods inherited from class java.lang.Object

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

Field Detail

missingFromResource

public final HashSet<String> missingFromResource

logger

protected final org.slf4j.Logger logger

server

protected final WebServer server

Constructor Detail

OpenApiParser

public OpenApiParser(WebServer server)

Method Detail

getInstance

public static OpenApiParser getInstance(WebServer server)

getServlets

public Set<Class<? extends jakarta.servlet.http.HttpServlet>> getServlets()

asYaml

public String asYaml(String jsonString)
              throws com.fasterxml.jackson.core.JsonProcessingException,
                     IOException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

IOException

toJSON

public org.json.JSONObject toJSON(AsyncInfo info)

toJSON

public org.json.JSONObject toJSON(Info info)

add

public void add(String tag,
                License license,
                org.json.JSONObject json)

add

public void add(String tag,
                Contact contact,
                org.json.JSONObject json)

getJSON

public org.json.JSONObject getJSON()

add

public void add(String tag,
                Tag[] tags,
                org.json.JSONObject json)

add

public void add(String tag,
                HashSet<Tag> tags,
                org.json.JSONObject json)

toJSON

public org.json.JSONObject toJSON(ObjectSchema p)

checkExamples

public Tuple checkExamples()

used to check if the examples are all correct

Returns:

add

public void add(String tag,
                OAuthFlows flows,
                org.json.JSONObject json)

add

public void add(String tag,
                OAuthFlow flow,
                org.json.JSONObject json)

add

public void add(Tag tag,
                org.json.JSONArray array)

add

public void add(ApiEndpoint endpoint,
                Operation operation,
                Method method,
                org.json.JSONObject paths)

addException

protected void addException(String n,
                            Class<?> ex,
                            org.json.JSONObject resp)

toJSON

public org.json.JSONObject toJSON(ArraySchema arraySchema)

createJSONSchemaFromSchema

public org.json.JSONObject createJSONSchemaFromSchema(org.json.JSONObject schema)

checkExample

public boolean checkExample(String value,
                            org.json.JSONObject schema,
                            SchemaType type)

checkExample

public boolean checkExample(ExampleObject e,
                            org.json.JSONObject schema,
                            SchemaType type)

getExamplesObject

public org.json.JSONObject getExamplesObject(ExampleObject[] examples)

getExamplesObject

public org.json.JSONObject getExamplesObject(List<ExampleObject> examples)

getExamplesObject

public org.json.JSONObject getExamplesObject(HashMap<String,String> examples)

getExamplesArray

public org.json.JSONArray getExamplesArray(ExampleObject[] examples)

getExamplesArray

public org.json.JSONArray getExamplesArray(List<ExampleObject> examples)

getExamplesArray

public org.json.JSONArray getExamplesArray(HashMap<String,String> examples)

toJSON

public org.json.JSONObject toJSON(Parameter p)

add

public void add(Parameter p,
                org.json.JSONArray params)

toJSON

public org.json.JSONObject toJSON(SchemaProperty[] properties)

add

public void add(String tag,
                SchemaProperty[] properties,
                org.json.JSONObject json)

add

public void add(String tag,
                Content[] value,
                org.json.JSONObject json)

add

public void add(String tag,
                Header[] value,
                org.json.JSONObject json)

toJSON

public org.json.JSONObject toJSON(ExampleObject example)

add

public void add(String tag,
                ExampleObject[] examples,
                org.json.JSONObject json)

toJSON

public org.json.JSONObject toJSON(Schema schema)

extractExamples

public HashMap<String,String> extractExamples(Parameter parameter)

extractExamples

public HashMap<String,String> extractExamples(Schema schema)

extractExamples

public HashMap<String,String> extractExamples(String example,
                                                    ExampleObject[] examples)

add

public void add(String tag,
                Schema schema,
                org.json.JSONObject json)

add

public void add(String tag,
                DiscriminatorMapping[] value,
                org.json.JSONObject json)

add

public void add(String tag,
                ExternalDocumentation value,
                org.json.JSONObject json)

add

public void add(String tag,
                double value,
                org.json.JSONObject json,
                Double ignoreIfThis)

add

public void add(String tag,
                Class<?>[] clzlist,
                org.json.JSONObject json)

add

public void add(String tag,
                Class<?> clz,
                org.json.JSONObject json)

add

public void add(String tag,
                boolean value,
                org.json.JSONObject json,
                Boolean ignoreIfThis)

add

public void add(String tag,
                int value,
                org.json.JSONObject json,
                Integer ignoreIfThis)

add

public void add(String tag,
                org.json.JSONObject values,
                org.json.JSONObject json)

add

public void add(String tag,
                org.json.JSONArray values,
                org.json.JSONObject json)

getStringFromResource

public String getStringFromResource(String name)

prepareString

public String prepareString(String input)

add

public void add(String tag,
                String value,
                org.json.JSONObject json)

parseValue

public Object parseValue(String value)

add

public void add(String tag,
                String value,
                org.json.JSONObject json,
                boolean parseValue)

add

public void add(String tag,
                String[] values,
                org.json.JSONObject json)

getYAML

public String getYAML()
               throws IOException

Throws:

IOException

getCachedJSON

public String getCachedJSON()

getCachedYAML

public String getCachedYAML()