master

分支 (1)

管理

管理

master

APIJSONdocs
/
build
/
introduction
/
introduction.html



<!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>Features &mdash; APIJSON Doc 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="next" title="Server-side Development" href="../quick_start/server_deployment/server_deployment.html" />
    <link rel="prev" title="APIJSON Documentation" href="../index.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 Doc


          </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 class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Features</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#examples">Examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/server_deployment/server_deployment.html">Server-side Development</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start/client_deployment/client_deployment.html">Client-side Development</a></li>
</ul>
<p class="caption"><span class="caption-text">Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../documentation/design_rules.html">API design style guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation/why.html">How does APIJSON works?</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation/what_achieved.html">What APIJSON has achieved?</a></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 Doc</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>Features</li>


      <li class="wy-breadcrumbs-aside">


            <a href="../_sources/introduction/introduction.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="features">
<h1>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h1>
<p><strong>For API developers:</strong></p>
<ul class="simple">
<li><p>APIJSON largely reduces API developers’ workload by reducing most API protocal design work and documentation work.</p></li>
<li><p>APIJSON supports automatic permission verification, version management and SQL injection prevention. Developers no longer need to worry about compatibility of APIs and documentation update with legacy apps.</p></li>
<li><p>With these feature, it saves communication time between front-end and back-end developers about the API design.</p></li>
</ul>
<p><strong>For API users:</strong></p>
<ul class="simple">
<li><p>You can get different types of data or different data forms by making just one request to the server. It’s very convenient and flexible, and it saves sending multiple requests with many different API endpoints.</p></li>
<li><p>It provides CRUD(read and write), Fuzzy Search, Remote Function Calls, etc. Other features include saving duplicate data, checking request history, etc.</p></li>
</ul>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<p><strong>Get a user:</strong></p>
<p>Request</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 <span class="nt">&quot;User&quot;</span><span class="p">:{</span>
 <span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Response</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 <span class="nt">&quot;User&quot;</span><span class="p">:{</span>
   <span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="mi">38710</span><span class="p">,</span>
   <span class="nt">&quot;sex&quot;</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span>
   <span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="s2">&quot;TommyLemon&quot;</span><span class="p">,</span>
   <span class="nt">&quot;certified&quot;</span><span class="p">:</span><span class="kc">true</span><span class="p">,</span>
   <span class="nt">&quot;tag&quot;</span><span class="p">:</span><span class="s2">&quot;Android&amp;Java&quot;</span><span class="p">,</span>
   <span class="nt">&quot;phone&quot;</span><span class="p">:</span><span class="mi">13000038710</span><span class="p">,</span>
   <span class="nt">&quot;head&quot;</span><span class="p">:</span><span class="s2">&quot;http://static.oschina.net/uploads/user/1218/2437072_100.jpg?t=1461076033000&quot;</span><span class="p">,</span>
   <span class="nt">&quot;date&quot;</span><span class="p">:</span><span class="mi">1485948110000</span><span class="p">,</span>
   <span class="nt">&quot;pictureList&quot;</span><span class="p">:[</span>
     <span class="s2">&quot;http://static.oschina.net/uploads/user/1218/2437072_100.jpg?t=1461076033000&quot;</span><span class="p">,</span>
     <span class="s2">&quot;http://common.cnblogs.com/images/icon_weibo_24.png&quot;</span>
   <span class="p">]</span>
 <span class="p">},</span>
 <span class="nt">&quot;code&quot;</span><span class="p">:</span><span class="mi">200</span><span class="p">,</span>
 <span class="nt">&quot;msg&quot;</span><span class="p">:</span><span class="s2">&quot;success&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
<p><a class="reference external" href="http://apijson.cn:8080/get/{&quot;User&quot;:{}}">Try it yourself</a></p>
<p><strong>Get an array of users</strong></p>
<p>Request</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 <span class="nt">&quot;[]&quot;</span><span class="p">:{</span>
   <span class="nt">&quot;count&quot;</span><span class="p">:</span><span class="mi">3</span><span class="p">,</span>
   <span class="nt">&quot;User&quot;</span><span class="p">:{</span>
     <span class="nt">&quot;@column&quot;</span><span class="p">:</span><span class="s2">&quot;id,name&quot;</span>
   <span class="p">}</span>
 <span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Response</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 <span class="nt">&quot;[]&quot;</span><span class="p">:[</span>
   <span class="p">{</span>
     <span class="nt">&quot;User&quot;</span><span class="p">:{</span>
       <span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="mi">38710</span><span class="p">,</span>
       <span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="s2">&quot;TommyLemon&quot;</span>
     <span class="p">}</span>
   <span class="p">},</span>
   <span class="p">{</span>
     <span class="nt">&quot;User&quot;</span><span class="p">:{</span>
       <span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="mi">70793</span><span class="p">,</span>
       <span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="s2">&quot;Strong&quot;</span>
     <span class="p">}</span>
   <span class="p">},</span>
   <span class="p">{</span>
     <span class="nt">&quot;User&quot;</span><span class="p">:{</span>
       <span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="mi">82001</span><span class="p">,</span>
       <span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="s2">&quot;Android&quot;</span>
     <span class="p">}</span>
   <span class="p">}</span>
 <span class="p">],</span>
 <span class="nt">&quot;code&quot;</span><span class="p">:</span><span class="mi">200</span><span class="p">,</span>
 <span class="nt">&quot;msg&quot;</span><span class="p">:</span><span class="s2">&quot;success&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
<p><a class="reference external" href="http://apijson.cn:8080/get/{&quot;[]&quot;:{&quot;count&quot;:3,&quot;User&quot;:{&quot;&#64;column&quot;:&quot;id,name&quot;}}}">Try it yourself</a></p>
<p><a class="reference external" href="http://apijson.cn/">Test it online</a></p>
<img alt="https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON_Auto_get.jpg" src="https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON_Auto_get.jpg" />
<div class="line-block">
<div class="line"><br /></div>
</div>
<img alt="https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON_Auto_code.jpg" src="https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON_Auto_code.jpg" />
</div>
</div>


           </div>

          </div>
          <footer>

    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

        <a href="../quick_start/server_deployment/server_deployment.html" class="btn btn-neutral float-right" title="Server-side Development" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


        <a href="../index.html" class="btn btn-neutral float-left" title="APIJSON Documentation" 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>