1 Star 1 Fork 0

APIJSON/APIJSONdocs

加入 Gitee
与超过 1400万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
该仓库未声明开源许可证文件(LICENSE),使用请关注具体项目描述及其代码上游依赖。
克隆/下载
what_achieved.html 9.85 KB
一键复制 编辑 原始数据 按行查看 历史
Ruoran Wang 提交于 2019-12-29 13:52 +08:00 . improvement
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>What APIJSON has achieved? &mdash; APIJSON Docs 1.0.0 documentation</title>
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/contentui.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
<link rel="stylesheet" href="../_static/contentui.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="prev" title="How does APIJSON works?" href="why.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home"> APIJSON Docs
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Quick Start</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/introduction.html">About APIJSON</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/features.html">Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/server_deployment/server_deployment.html">Server-side Deployment</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/client_deployment/client_deployment.html">Client-side Deployment</a></li>
</ul>
<p class="caption"><span class="caption-text">Documentation</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="design_rules.html">API design style guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="why.html">How does APIJSON works?</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">What APIJSON has achieved?</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#functions">Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="#request-methods">Request Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="#request-body-structures">Request body structures</a></li>
<li class="toctree-l2"><a class="reference internal" href="#response-body">Response body</a></li>
<li class="toctree-l2"><a class="reference internal" href="#build-in-functions">Build-in functions</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">APIJSON Docs</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> &raquo;</li>
<li>What APIJSON has achieved?</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/documentation/what_achieved.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="what-apijson-has-achieved">
<h1>What APIJSON has achieved?<a class="headerlink" href="#what-apijson-has-achieved" title="Permalink to this headline"></a></h1>
<div class="section" id="functions">
<h2>Functions<a class="headerlink" href="#functions" title="Permalink to this headline"></a></h2>
<p>•Registeration and login</p>
<p>•CRUD and remote procedure call(RPC) of functions</p>
<p>•Setting orders and pages on returned data</p>
<p>•Calculating and grouping data</p>
<p>•Fuzzy matching search</p>
<p>•Regular expressions</p>
<p>•Joining tables, subquery, and other SQL functions</p>
</div>
<hr class="docutils" />
<div class="section" id="request-methods">
<h2>Request Methods<a class="headerlink" href="#request-methods" title="Permalink to this headline"></a></h2>
<p>The APIJSON supports the following request methods:</p>
<p><strong>GET,HEAD,GETS,HEADS,POST,PUT,DELETE</strong></p>
<p>For details of these requests methods, see <a class="reference external" href="https://apijsondocs.readthedocs.io/en/latest/documentation/design_rules.html#methods-and-http-mapping">design rules</a>.</p>
</div>
<hr class="docutils" />
<div class="section" id="request-body-structures">
<h2>Request body structures<a class="headerlink" href="#request-body-structures" title="Permalink to this headline"></a></h2>
<p>{ “Table”:{…} }</p>
<p>{ “Table0”:{…}, “Table1”:{…}, “Table2”:{…} … }</p>
<p>{ “[]”:{ “Table”:{…} } }</p>
<p>{ “[]”:{ “Table0”:{…}, “Table1”:{…}, “Array0[]”:{…}, … } }
.
.
.
etc.</p>
</div>
<hr class="docutils" />
<div class="section" id="response-body">
<h2>Response body<a class="headerlink" href="#response-body" title="Permalink to this headline"></a></h2>
<p>The reponse body structure will be the same as request body structure.</p>
</div>
<hr class="docutils" />
<div class="section" id="build-in-functions">
<h2>Build-in functions<a class="headerlink" href="#build-in-functions" title="Permalink to this headline"></a></h2>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span>&quot;key[]&quot;:{} // retrieve data arrays.
&quot;key{}&quot;:[1,2,3] // Add constraints on returned data.
&quot;key{}&quot;:&quot;&lt;=10;length(key)&gt;1...&quot; // Add constraints on returned data.
&quot;key()&quot;:&quot;function(arg0,arg1...)&quot; // RPC of functions.
&quot;key@&quot;:&quot;key0/key1.../targetKey&quot; // Refer a value.
&quot;key$&quot;:&quot;%abc%&quot; // Fuzzy machting research.
&quot;key~&quot;:&quot;^[0-9]+$&quot; // Include regular expressions.
&quot;key%&quot;:&quot;2018-01-01,2018-10-01&quot; // Add constraints on returned data.
&quot;key+&quot;:[1] // Add/Expand data.
&quot;key-&quot;:888.88 // Reduce/Delete data.
&quot;name:alias&quot; // Make an alias.
&quot;@combine&quot;:&quot;name~,tag~&quot; // Set more than two conditions.
&quot;@column&quot;:&quot;id,sex,name&quot; // Set returned value.
&quot;@group&quot;:&quot;userId&quot; // Group data.
&quot;@having&quot;:&quot;max(id)&gt;=100&quot; // Add aggregate functions.
&quot;@order&quot;:&quot;date-,name+&quot; // Set orders.
&quot;@schema&quot;:&quot;sys&quot; //
&quot;@database&quot;:&quot;POSTGRESQL&quot; // Interact with different databases.
&quot;@explain&quot;:true // Performance analysis.
&quot;@role&quot;:&quot;LOGIN&quot; // Set the visiting role.
</pre></div>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="why.html" class="btn btn-neutral float-left" title="How does APIJSON works?" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2019, Ruoran Wang
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
JavaScript
1
https://gitee.com/APIJSON/APIJSONdocs.git
git@gitee.com:APIJSON/APIJSONdocs.git
APIJSON
APIJSONdocs
APIJSONdocs
master

搜索帮助