mirror of
https://github.com/jlengrand/openapi-generator.git
synced 2026-05-18 00:21:20 +00:00
61 lines
2.3 KiB
Plaintext
61 lines
2.3 KiB
Plaintext
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<title>API Reference</title>
|
|
</head>
|
|
<body>
|
|
<h1>{{{appName}}}</h1>
|
|
<div class="app-desc">{{{appDescription}}} for {{partner}}</div>
|
|
{{#infoUrl}}<div class="app-desc">More information: <a href="{{{infoUrl}}}">{{{infoUrl}}}</a></div>{{/infoUrl}}
|
|
{{#infoEmail}}<div class="app-desc">Contact Info: <a href="{{{infoEmail}}}">{{{infoEmail}}}</a></div>{{/infoEmail}}
|
|
{{#version}}<div class="app-desc">Version: {{{version}}}</div>{{/version}}
|
|
<div class="license-info">{{{licenseInfo}}}</div>
|
|
<div class="license-url">{{{licenseUrl}}}</div>
|
|
<h2>Access</h2>
|
|
<div class="method-summary">Customize this message as you see fit!</div>
|
|
<h2>Methods</h2>
|
|
{{#apiInfo}}
|
|
{{#apis}}
|
|
{{#operations}}{{#operation}}
|
|
<div class="method">
|
|
<div class="method-path"><pre class="{{httpMethod}}"><code class="huge"><span>{{httpMethod}}</span>: {{path}}</code></pre></div>
|
|
<div class="method-tags"> {{#tags}}<span class="method-tag">{{this}}</span>{{/tags}}</div>
|
|
<div class="method-summary"><span class="nickname">{{nickname}}</span> {{summary}}</div>
|
|
<div class="method-notes">{{notes}}</div>
|
|
|
|
<h3 class="field-label">Parameters</h3>
|
|
<div class="field-items">
|
|
{{#allParams}}{{>queryParam}}{{>pathParam}}{{>bodyParam}}{{>headerParam}}{{>formParam}}
|
|
{{/allParams}}
|
|
</div> <!-- field-items -->
|
|
<h3 class="field-label">Return type</h3>
|
|
|
|
<div class="return-type"><a href="#{{returnContainer}}">{{{returnType}}}</a></div>
|
|
|
|
{{#examples}}
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: {{{contentType}}}</div>
|
|
<pre class="example"><code>{{example}}</code></pre>
|
|
{{/examples}}
|
|
</div> <!-- method -->
|
|
<hr>
|
|
{{/operation}}{{/operations}}
|
|
{{/apis}}{{/apiInfo}}
|
|
|
|
<h2>Models</h2>
|
|
{{#models}}
|
|
{{#model}}
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="{{classname}}">{{classname}}</a></h3>
|
|
<div class="field-items">
|
|
{{#vars}}<div class="param">{{name}} {{#isNotRequired}}(optional){{/isNotRequired}}</div><div class="param-desc"><span class="param-type">{{datatype}}</span> {{description}}</div>
|
|
{{/vars}}
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
{{/model}}
|
|
{{/models}}
|
|
<style>
|
|
{{>style.css}}
|
|
</style>
|
|
</body>
|
|
</html> |