merest
Version:
Express based REST-full API for Mongoose models
115 lines (99 loc) • 4.5 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Configuration | Merest</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">API Configuration</h1>
<section>
<article>
<a name='app'></a>
<h3>Setting up an API Application</h3>
<p>In order to configure API Application you should to pass the <code>options</options>
parameter to the <code>merest.ModelAPIExpress</code> contructor:
</p>
<pre class="prettyprint source lang-javascript"><code>const api = new merest.ModelAPIExpress({
title: 'Merest-Sample API',
path: '/api/v1',
host: 'localhost:8000',
options: false,
transformResponse: <function>
});</code></pre>
<p>Avaliable parameters are:</p>
<ul>
<li><strong>title</strong>: <code>String</code> - The title of API. <<code>SWAGGER</code>></li>
<li><strong>version</strong>: <code>String</code> - The version of API. <<code>SWAGGER</code>></li>
<li><strong>path</strong>: <code>String</code> - The path of api root. The application doesn't mount it self on this path. <<code>SWAGGER</code>></li>
<li><strong>host</strong>: <code>String</code> - The host to reach API. <<code>SWAGGER</code>></li>
<li><strong>options</strong>: <code>Boolean</code> - allows or denies the OPTION end-point on the application level</li>
<li><strong>transformResponse</strong>: <code>Function</code> - the function to transform standard response. For details see <a href="end-points.html#transform-response">Transform response</a></li>
</ul>
<p><<code>SWAGGER</code>> - the parameter is mandatory for correct <strong>swagger</strong> support</p>
<br class="clear">
<hr>
<a href='installation.html'>Next (Installation) ></a>
</article>
</section>
</div>
<nav><h2>
<a href="index.html">merest</a>
</h2>
<h3><a href="installation.html">Installation</a></h3>
<ul>
<li><a href="installation.html#prerequisites">Prerequisites</a></li>
<li><a href="installation.html#npm-install">npm installation</a></li>
<li><a href="installation.html#development">Development</a></li>
</ul>
<h3><a href="cook-book.html">Cook-book</a></h3>
<h3><a href="conf-levels.html">API Configuration</a></h3>
<ul>
<li><a href="conf-levels.html">Configuration levels</a></li>
<li><a href="conf-app.html">API Application</a></li>
<li><a href="conf-router.html">Router</a></li>
<li><a href="conf-end-points.html">End-point</a></li>
<li><a href="conf-methods.html">Model methods</a></li>
</ul>
<h3><a href="end-points.html">API Requests and Responses</a></h3>
<ul>
<li><a href="end-points.html">Common reponses</a></li>
<li><a href="end-points.html#ep_options">Options</a></li>
<li><a href="end-points.html#ep_search">Search</a></li>
<li><a href="end-points.html#ep_create">Create</a></li>
<li><a href="end-points.html#ep_details">Details</a></li>
<li><a href="end-points.html#ep_update">Update</a></li>
<li><a href="end-points.html#ep_delete">Delete</a></li>
<li><a href="end-points.html#transform-response">Custom response</a></li>
</ul>
<h3><a href="swagger.html">Swagger support</a></h3>
<ul>
<li><a href="swagger.html#install">Installation</a></li>
<li><a href="swagger.html#api-conf">Configure API</a></li>
<li><a href="swagger.html#document">Creating <code>swagger.json</code></a></li>
<li><a href="swagger.html#api-docs">Exposing the api-docs</a></li>
<li><a href="swagger.html#swagger-ui">Embedded swagger-ui</a></li>
</ul>
<h3>Specifications</h3>
<ul>
<li><a href="ModelAPIExpress.html">ModelAPIExpress</a></li>
<li><a href="merest-swagger.html">Swagger-support methods</a></li>
<li><a href="ModelAPIRouter.html">ModelAPIRouter</a></li>
<li><a href="ModelAPIError.html">ModelAPIError</a></li>
</ul>
</nav>
<br class="clear">
<footer>
Documentation generated with <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>