UNPKG

@loopback/docs

Version:
597 lines (516 loc) 37.3 kB
<!DOCTYPE html> <!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]--> <!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]--> <!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]--> <!--[if gt IE 8]><!--> <html class="no-js"> <!--<![endif]--> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> <title></title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <link rel="stylesheet" href="css/bootstrap.min.css"> <link rel="stylesheet" href="css/code-themes/sl-theme.css"> <link rel="stylesheet" href="css/main.css"> </head> <body> <div class="navbar navbar-inverse navbar-static-top" role="navigation"> <div class="navbar-header"> <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <a class="navbar-brand" href="/">docs.strongloop.com</a> </div> <div id="modules"></div> </div> <div class="row"> <div class="col-lg-3 column scroll-spy-target"> <ul class="nav nav-pills nav-stacked"> <div id="versions"></div> <li class="depth-1"> <a href="#change-log">Change Log</a> </li> <li class="depth-2"> <a href="#0-9-1-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-9-0-loopback-example-todo-0-9-1-2018-05-08">0.9.1</a> </li> <li class="depth-1"> <a href="#0-9-0-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-7-3-loopback-example-todo-0-9-0-2018-05-03">0.9.0</a> </li> <li class="depth-3"> <a href="#features">Features</a> </li> <li class="depth-1"> <a href="#0-8-0-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-7-3-loopback-example-todo-0-8-0-2018-05-03">0.8.0</a> </li> <li class="depth-3"> <a href="#features-1">Features</a> </li> <li class="depth-2"> <a href="#0-7-3-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-7-2-loopback-example-todo-0-7-3-2018-04-26">0.7.3</a> </li> <li class="depth-2"> <a href="#0-7-2-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-7-1-loopback-example-todo-0-7-2-2018-04-26">0.7.2</a> </li> <li class="depth-2"> <a href="#0-7-1-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-7-0-loopback-example-todo-0-7-1-2018-04-25">0.7.1</a> </li> <li class="depth-1"> <a href="#0-7-0-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-6-3-loopback-example-todo-0-7-0-2018-04-16">0.7.0</a> </li> <li class="depth-2"> <a href="#0-6-3-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-6-2-loopback-example-todo-0-6-3-2018-04-16">0.6.3</a> </li> <li class="depth-2"> <a href="#0-6-2-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-6-1-loopback-example-todo-0-6-2-2018-04-12">0.6.2</a> </li> <li class="depth-2"> <a href="#0-6-1-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-6-0-loopback-example-todo-0-6-1-2018-04-11">0.6.1</a> </li> <li class="depth-1"> <a href="#0-6-0-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-5-2-loopback-example-todo-0-6-0-2018-04-11">0.6.0</a> </li> <li class="depth-3"> <a href="#bug-fixes">Bug Fixes</a> </li> <li class="depth-3"> <a href="#features-2">Features</a> </li> <li class="depth-2"> <a href="#0-5-3-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-5-2-loopback-example-todo-0-5-3-2018-04-06">0.5.3</a> </li> <li class="depth-2"> <a href="#0-5-2-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-5-1-loopback-example-todo-0-5-2-2018-04-04">0.5.2</a> </li> <li class="depth-2"> <a href="#0-5-1-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-5-0-loopback-example-todo-0-5-1-2018-04-02">0.5.1</a> </li> <li class="depth-1"> <a href="#0-5-0-2018-03-29">0.5.0</a> </li> <li class="depth-3"> <a href="#code-refactoring">Code Refactoring</a> </li> <li class="depth-3"> <a href="#breaking-changes">BREAKING CHANGES</a> </li> <li class="depth-2"> <a href="#0-4-1-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-0-4-0-loopback-example-getting-started-0-4-1-2018-03-23">0.4.1</a> </li> <li class="depth-3"> <a href="#bug-fixes-1">Bug Fixes</a> </li> <li class="depth-3"> <a href="#reverts">Reverts</a> </li> <li class="depth-1"> <a href="#0-4-0-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-0-3-4-loopback-example-getting-started-0-4-0-2018-03-21">0.4.0</a> </li> <li class="depth-3"> <a href="#features-3">Features</a> </li> <li class="depth-3"> <a href="#breaking-changes-1">BREAKING CHANGES</a> </li> <li class="depth-2"> <a href="#0-3-4-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-0-3-3-loopback-example-getting-started-0-3-4-2018-03-14">0.3.4</a> </li> <li class="depth-2"> <a href="#0-3-3-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-0-3-2-loopback-example-getting-started-0-3-3-2018-03-13">0.3.3</a> </li> <li class="depth-2"> <a href="#0-3-2-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-0-3-1-loopback-example-getting-started-0-3-2-2018-03-08">0.3.2</a> </li> <li class="depth-2"> <a href="#0-3-1-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-0-3-0-loopback-example-getting-started-0-3-1-2018-03-07">0.3.1</a> </li> <li class="depth-1"> <a href="#0-3-0-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-0-2-0-loopback-example-getting-started-0-3-0-2018-03-06">0.3.0</a> </li> <li class="depth-3"> <a href="#bug-fixes-2">Bug Fixes</a> </li> <li class="depth-3"> <a href="#features-4">Features</a> </li> <li class="depth-1"> <a href="#0-2-0-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-0-1-2-loopback-example-getting-started-0-2-0-2018-03-01">0.2.0</a> </li> <li class="depth-2"> <a href="#0-1-2-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-0-1-1-loopback-example-getting-started-0-1-2-2018-03-01">0.1.2</a> </li> <li class="depth-3"> <a href="#features-5">Features</a> </li> <li class="depth-2"> <a href="#0-1-1-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-0-1-0-loopback-example-getting-started-0-1-1-2018-02-23">0.1.1</a> </li> <li class="depth-1"> <a href="#0-1-0-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-1-0-1-alpha-7-loopback-example-getting-started-0-1-0-2018-02-21">0.1.0</a> </li> <li class="depth-3"> <a href="#bug-fixes-3">Bug Fixes</a> </li> <li class="depth-3"> <a href="#features-6">Features</a> </li> <li class="depth-2"> <a href="#1-0-1-alpha-7-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-1-0-1-alpha-6-loopback-example-getting-started-1-0-1-alpha-7-2018-02-15">1.0.1-alpha.7</a> </li> <li class="depth-3"> <a href="#bug-fixes-4">Bug Fixes</a> </li> <li class="depth-2"> <a href="#1-0-1-alpha-6-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-1-0-1-alpha-5-loopback-example-getting-started-1-0-1-alpha-6-2018-02-07">1.0.1-alpha.6</a> </li> <li class="depth-3"> <a href="#bug-fixes-5">Bug Fixes</a> </li> <li class="depth-3"> <a href="#build">build</a> </li> <li class="depth-3"> <a href="#breaking-changes-2">BREAKING CHANGES</a> </li> <li class="depth-2"> <a href="#1-0-1-alpha-5-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-1-0-1-alpha-4-loopback-example-getting-started-1-0-1-alpha-5-2018-02-04">1.0.1-alpha.5</a> </li> <li class="depth-2"> <a href="#1-0-1-alpha-4-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-1-0-1-alpha-3-loopback-example-getting-started-1-0-1-alpha-4-2018-01-30">1.0.1-alpha.4</a> </li> <li class="depth-2"> <a href="#1-0-1-alpha-3-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-1-0-1-alpha-2-loopback-example-getting-started-1-0-1-alpha-3-2018-01-29">1.0.1-alpha.3</a> </li> <li class="depth-2"> <a href="#1-0-1-alpha-2-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-1-0-1-alpha-1-loopback-example-getting-started-1-0-1-alpha-2-2018-01-26">1.0.1-alpha.2</a> </li> <li class="depth-2"> <a href="#1-0-1-alpha-1-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-1-0-1-alpha-0-loopback-example-getting-started-1-0-1-alpha-1-2018-01-26">1.0.1-alpha.1</a> </li> <li class="depth-3"> <a href="#bug-fixes-6">Bug Fixes</a> </li> <li class="depth-2"> <a href="#1-0-1-alpha-0-2018-01-19">1.0.1-alpha.0</a> </li> <li class="depth-3"> <a href="#bug-fixes-7">Bug Fixes</a> </li> <li class="depth-3"> <a href="#features-7">Features</a> </li> <li class="depth-1"> <a href="#loopback-example-todo">@loopback/example-todo</a> </li> <li class="depth-2"> <a href="#overview">Overview</a> </li> <li class="depth-2"> <a href="#setup">Setup</a> </li> <li class="depth-2"> <a href="#tutorial">Tutorial</a> </li> <li class="depth-3"> <a href="#steps">Steps</a> </li> <li class="depth-2"> <a href="#try-it-out">Try it out</a> </li> <li class="depth-3"> <a href="#stuck">Stuck?</a> </li> <li class="depth-3"> <a href="#bugs-feedback">Bugs/Feedback</a> </li> <li class="depth-2"> <a href="#contributions">Contributions</a> </li> <li class="depth-2"> <a href="#tests">Tests</a> </li> <li class="depth-2"> <a href="#contributors">Contributors</a> </li> <li class="depth-2"> <a href="#license">License</a> </li> </ul> </div> <div class="col-lg-9 col-lg-offset-3 column" data-spy="scroll" data-target=".scroll-spy-target" data-offset="0"> <div class="readability"> <a name="change-log"></a><h1 id="undefinedchange-log">Change Log <small>v0.9.1</small></h1> <p>All notable changes to this project will be documented in this file. See <a href="https://conventionalcommits.org">Conventional Commits</a> for commit guidelines.</p> <p><a name="0.9.1"></a></p> <a name="0-9-1-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-9-0-loopback-example-todo-0-9-1-2018-05-08"></a><h2 id="undefined0-9-1-2018-05-08-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-todo@0.9.0...@loopback/example-todo@0.9.1">0.9.1</a> (2018-05-08)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-todo</p> <p><a name="0.9.0"></a></p> <a name="0-9-0-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-7-3-loopback-example-todo-0-9-0-2018-05-03"></a><h1 id="undefined0-9-0-2018-05-03-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-todo@0.7.3...@loopback/example-todo@0.9.0">0.9.0</a> (2018-05-03)</h1> <a name="features"></a><h3 id="undefinedfeatures">Features</h3> <ul> <li>add helper package &quot;dist-util&quot; (<a href="https://github.com/strongloop/loopback-next/commit/532f153">532f153</a>)</li> </ul> <p><a name="0.8.0"></a></p> <a name="0-8-0-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-7-3-loopback-example-todo-0-8-0-2018-05-03"></a><h1 id="undefined0-8-0-2018-05-03-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-todo@0.7.3...@loopback/example-todo@0.8.0">0.8.0</a> (2018-05-03)</h1> <a name="features-1"></a><h3 id="undefinedfeatures">Features</h3> <ul> <li>add helper package &quot;dist-util&quot; (<a href="https://github.com/strongloop/loopback-next/commit/532f153">532f153</a>)</li> </ul> <p><a name="0.7.3"></a></p> <a name="0-7-3-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-7-2-loopback-example-todo-0-7-3-2018-04-26"></a><h2 id="undefined0-7-3-2018-04-26-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-todo@0.7.2...@loopback/example-todo@0.7.3">0.7.3</a> (2018-04-26)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-todo</p> <p><a name="0.7.2"></a></p> <a name="0-7-2-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-7-1-loopback-example-todo-0-7-2-2018-04-26"></a><h2 id="undefined0-7-2-2018-04-26-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-todo@0.7.1...@loopback/example-todo@0.7.2">0.7.2</a> (2018-04-26)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-todo</p> <p><a name="0.7.1"></a></p> <a name="0-7-1-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-7-0-loopback-example-todo-0-7-1-2018-04-25"></a><h2 id="undefined0-7-1-2018-04-25-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-todo@0.7.0...@loopback/example-todo@0.7.1">0.7.1</a> (2018-04-25)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-todo</p> <p><a name="0.7.0"></a></p> <a name="0-7-0-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-6-3-loopback-example-todo-0-7-0-2018-04-16"></a><h1 id="undefined0-7-0-2018-04-16-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-todo@0.6.3...@loopback/example-todo@0.7.0">0.7.0</a> (2018-04-16)</h1> <p><strong>Note:</strong> Version bump only for package @loopback/example-todo</p> <p><a name="0.6.3"></a></p> <a name="0-6-3-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-6-2-loopback-example-todo-0-6-3-2018-04-16"></a><h2 id="undefined0-6-3-2018-04-16-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-todo@0.6.2...@loopback/example-todo@0.6.3">0.6.3</a> (2018-04-16)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-todo</p> <p><a name="0.6.2"></a></p> <a name="0-6-2-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-6-1-loopback-example-todo-0-6-2-2018-04-12"></a><h2 id="undefined0-6-2-2018-04-12-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-todo@0.6.1...@loopback/example-todo@0.6.2">0.6.2</a> (2018-04-12)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-todo</p> <p><a name="0.6.1"></a></p> <a name="0-6-1-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-6-0-loopback-example-todo-0-6-1-2018-04-11"></a><h2 id="undefined0-6-1-2018-04-11-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-todo@0.6.0...@loopback/example-todo@0.6.1">0.6.1</a> (2018-04-11)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-todo</p> <p><a name="0.6.0"></a></p> <a name="0-6-0-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-5-2-loopback-example-todo-0-6-0-2018-04-11"></a><h1 id="undefined0-6-0-2018-04-11-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-todo@0.5.2...@loopback/example-todo@0.6.0">0.6.0</a> (2018-04-11)</h1> <a name="bug-fixes"></a><h3 id="undefinedbug-fixes">Bug Fixes</h3> <ul> <li>change file names to fit advocated naming convention (<a href="https://github.com/strongloop/loopback-next/commit/0331df8">0331df8</a>)</li> </ul> <a name="features-2"></a><h3 id="undefinedfeatures">Features</h3> <ul> <li><strong>repository:</strong> have <a href="https://github.com/repository">@repository</a> take in constructor as arg (<a href="https://github.com/strongloop/loopback-next/commit/3db07eb">3db07eb</a>)</li> </ul> <p><a name="0.5.3"></a></p> <a name="0-5-3-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-5-2-loopback-example-todo-0-5-3-2018-04-06"></a><h2 id="undefined0-5-3-2018-04-06-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-todo@0.5.2...@loopback/example-todo@0.5.3">0.5.3</a> (2018-04-06)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-todo</p> <p><a name="0.5.2"></a></p> <a name="0-5-2-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-5-1-loopback-example-todo-0-5-2-2018-04-04"></a><h2 id="undefined0-5-2-2018-04-04-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-todo@0.5.1...@loopback/example-todo@0.5.2">0.5.2</a> (2018-04-04)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-todo</p> <p><a name="0.5.1"></a></p> <a name="0-5-1-https-github-com-strongloop-loopback-next-compare-loopback-example-todo-0-5-0-loopback-example-todo-0-5-1-2018-04-02"></a><h2 id="undefined0-5-1-2018-04-02-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-todo@0.5.0...@loopback/example-todo@0.5.1">0.5.1</a> (2018-04-02)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-todo</p> <p><a name="0.5.0"></a></p> <a name="0-5-0-2018-03-29"></a><h1 id="undefined0-5-0-2018-03-29-">0.5.0 (2018-03-29)</h1> <a name="code-refactoring"></a><h3 id="undefinedcode-refactoring">Code Refactoring</h3> <ul> <li>renamed example-getting-started to example-todo (<a href="https://github.com/strongloop/loopback-next/commit/7a09f1b">7a09f1b</a>)</li> </ul> <a name="breaking-changes"></a><h3 id="undefinedbreaking-changes">BREAKING CHANGES</h3> <ul> <li>example-getting-started is now example-todo</li> </ul> <p><a name="0.4.1"></a></p> <a name="0-4-1-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-0-4-0-loopback-example-getting-started-0-4-1-2018-03-23"></a><h2 id="undefined0-4-1-2018-03-23-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-getting-started@0.4.0...@loopback/example-getting-started@0.4.1">0.4.1</a> (2018-03-23)</h2> <a name="bug-fixes-1"></a><h3 id="undefinedbug-fixes">Bug Fixes</h3> <ul> <li><strong>example-getting-started:</strong> remove old model from sample data (<a href="https://github.com/strongloop/loopback-next/commit/4fee3b1">4fee3b1</a>)</li> </ul> <a name="reverts"></a><h3 id="undefinedreverts">Reverts</h3> <ul> <li><strong>example-getting-started:</strong> sync code and docs (<a href="https://github.com/strongloop/loopback-next/commit/5f54b96">5f54b96</a>)</li> </ul> <p><a name="0.4.0"></a></p> <a name="0-4-0-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-0-3-4-loopback-example-getting-started-0-4-0-2018-03-21"></a><h1 id="undefined0-4-0-2018-03-21-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-getting-started@0.3.4...@loopback/example-getting-started@0.4.0">0.4.0</a> (2018-03-21)</h1> <a name="features-3"></a><h3 id="undefinedfeatures">Features</h3> <ul> <li><strong>rest:</strong> expose app.requestHandler function (<a href="https://github.com/strongloop/loopback-next/commit/20a41ac">20a41ac</a>)</li> </ul> <a name="breaking-changes-1"></a><h3 id="undefinedbreaking-changes">BREAKING CHANGES</h3> <ul> <li><strong>rest:</strong> <code>RestServer#handleHttp</code> was renamed to <code>RestServer#requestHandler</code>.</li> </ul> <p><a name="0.3.4"></a></p> <a name="0-3-4-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-0-3-3-loopback-example-getting-started-0-3-4-2018-03-14"></a><h2 id="undefined0-3-4-2018-03-14-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-getting-started@0.3.3...@loopback/example-getting-started@0.3.4">0.3.4</a> (2018-03-14)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-getting-started</p> <p><a name="0.3.3"></a></p> <a name="0-3-3-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-0-3-2-loopback-example-getting-started-0-3-3-2018-03-13"></a><h2 id="undefined0-3-3-2018-03-13-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-getting-started@0.3.2...@loopback/example-getting-started@0.3.3">0.3.3</a> (2018-03-13)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-getting-started</p> <p><a name="0.3.2"></a></p> <a name="0-3-2-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-0-3-1-loopback-example-getting-started-0-3-2-2018-03-08"></a><h2 id="undefined0-3-2-2018-03-08-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-getting-started@0.3.1...@loopback/example-getting-started@0.3.2">0.3.2</a> (2018-03-08)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-getting-started</p> <p><a name="0.3.1"></a></p> <a name="0-3-1-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-0-3-0-loopback-example-getting-started-0-3-1-2018-03-07"></a><h2 id="undefined0-3-1-2018-03-07-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-getting-started@0.3.0...@loopback/example-getting-started@0.3.1">0.3.1</a> (2018-03-07)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-getting-started</p> <p><a name="0.3.0"></a></p> <a name="0-3-0-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-0-2-0-loopback-example-getting-started-0-3-0-2018-03-06"></a><h1 id="undefined0-3-0-2018-03-06-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-getting-started@0.2.0...@loopback/example-getting-started@0.3.0">0.3.0</a> (2018-03-06)</h1> <a name="bug-fixes-2"></a><h3 id="undefinedbug-fixes">Bug Fixes</h3> <ul> <li>fix typo of <code>additional</code> (<a href="https://github.com/strongloop/loopback-next/commit/2fd7610">2fd7610</a>)</li> </ul> <a name="features-4"></a><h3 id="undefinedfeatures">Features</h3> <ul> <li>upgrade from swagger 2 to openapi 3 (<a href="https://github.com/strongloop/loopback-next/commit/71e5af1">71e5af1</a>)</li> </ul> <p><a name="0.2.0"></a></p> <a name="0-2-0-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-0-1-2-loopback-example-getting-started-0-2-0-2018-03-01"></a><h1 id="undefined0-2-0-2018-03-01-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-getting-started@0.1.2...@loopback/example-getting-started@0.2.0">0.2.0</a> (2018-03-01)</h1> <p><strong>Note:</strong> Version bump only for package @loopback/example-getting-started</p> <p><a name="0.1.2"></a></p> <a name="0-1-2-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-0-1-1-loopback-example-getting-started-0-1-2-2018-03-01"></a><h2 id="undefined0-1-2-2018-03-01-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-getting-started@0.1.1...@loopback/example-getting-started@0.1.2">0.1.2</a> (2018-03-01)</h2> <a name="features-5"></a><h3 id="undefinedfeatures">Features</h3> <ul> <li><strong>repository:</strong> add datasource method in repository mixin (<a href="https://github.com/strongloop/loopback-next/commit/85347fa">85347fa</a>)</li> <li>add repository booter (<a href="https://github.com/strongloop/loopback-next/issues/1030">#1030</a>) (<a href="https://github.com/strongloop/loopback-next/commit/43ea7a8">43ea7a8</a>)</li> </ul> <p><a name="0.1.1"></a></p> <a name="0-1-1-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-0-1-0-loopback-example-getting-started-0-1-1-2018-02-23"></a><h2 id="undefined0-1-1-2018-02-23-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-getting-started@0.1.0...@loopback/example-getting-started@0.1.1">0.1.1</a> (2018-02-23)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-getting-started</p> <p><a name="0.1.0"></a></p> <a name="0-1-0-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-1-0-1-alpha-7-loopback-example-getting-started-0-1-0-2018-02-21"></a><h1 id="undefined0-1-0-2018-02-21-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-getting-started@1.0.1-alpha.7...@loopback/example-getting-started@0.1.0">0.1.0</a> (2018-02-21)</h1> <a name="bug-fixes-3"></a><h3 id="undefinedbug-fixes">Bug Fixes</h3> <ul> <li><strong>example-getting-started:</strong> correct spacing on navigation sections (<a href="https://github.com/strongloop/loopback-next/commit/0dde314">0dde314</a>)</li> </ul> <a name="features-6"></a><h3 id="undefinedfeatures">Features</h3> <ul> <li><a href="https://github.com/loopback">@loopback</a>/boot (<a href="https://github.com/strongloop/loopback-next/issues/858">#858</a>) (<a href="https://github.com/strongloop/loopback-next/commit/c2ca8be">c2ca8be</a>)</li> </ul> <p><a name="1.0.1-alpha.7"></a></p> <a name="1-0-1-alpha-7-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-1-0-1-alpha-6-loopback-example-getting-started-1-0-1-alpha-7-2018-02-15"></a><h2 id="undefined1-0-1-alpha-7-2018-02-15-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-getting-started@1.0.1-alpha.6...@loopback/example-getting-started@1.0.1-alpha.7">1.0.1-alpha.7</a> (2018-02-15)</h2> <a name="bug-fixes-4"></a><h3 id="undefinedbug-fixes">Bug Fixes</h3> <ul> <li><strong>example-getting-started:</strong> remove juggler warning (<a href="https://github.com/strongloop/loopback-next/commit/86139f6">86139f6</a>)</li> <li><strong>example-getting-started:</strong> use sinon from testlab (<a href="https://github.com/strongloop/loopback-next/issues/984">#984</a>) (<a href="https://github.com/strongloop/loopback-next/commit/09fc791">09fc791</a>)</li> </ul> <p><a name="1.0.1-alpha.6"></a></p> <a name="1-0-1-alpha-6-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-1-0-1-alpha-5-loopback-example-getting-started-1-0-1-alpha-6-2018-02-07"></a><h2 id="undefined1-0-1-alpha-6-2018-02-07-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-getting-started@1.0.1-alpha.5...@loopback/example-getting-started@1.0.1-alpha.6">1.0.1-alpha.6</a> (2018-02-07)</h2> <a name="bug-fixes-5"></a><h3 id="undefinedbug-fixes">Bug Fixes</h3> <ul> <li><strong>build:</strong> fix tslint config and slipped violations (<a href="https://github.com/strongloop/loopback-next/commit/22f8e05">22f8e05</a>)</li> <li><strong>example-getting-started:</strong> update readme to use RestApplication (<a href="https://github.com/strongloop/loopback-next/issues/961">#961</a>) (<a href="https://github.com/strongloop/loopback-next/commit/b3e2c0e">b3e2c0e</a>)</li> <li><strong>example-getting-started:</strong> use RestApplication (<a href="https://github.com/strongloop/loopback-next/issues/955">#955</a>) (<a href="https://github.com/strongloop/loopback-next/commit/3829878">3829878</a>)</li> <li>use parameter level decorators for openapi params (<a href="https://github.com/strongloop/loopback-next/commit/c29dd19">c29dd19</a>)</li> </ul> <a name="build"></a><h3 id="undefinedbuild">build</h3> <ul> <li>drop dist6 related targets (<a href="https://github.com/strongloop/loopback-next/issues/945">#945</a>) (<a href="https://github.com/strongloop/loopback-next/commit/a2368ce">a2368ce</a>)</li> </ul> <a name="breaking-changes-2"></a><h3 id="undefinedbreaking-changes">BREAKING CHANGES</h3> <ul> <li>Support for Node.js version lower than 8.0 has been dropped. Please upgrade to the latest Node.js 8.x LTS version.</li> </ul> <p>Co-Authored-by: Taranveer Virk <a href="mailto:taranveer@virk.cc">taranveer@virk.cc</a></p> <p><a name="1.0.1-alpha.5"></a></p> <a name="1-0-1-alpha-5-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-1-0-1-alpha-4-loopback-example-getting-started-1-0-1-alpha-5-2018-02-04"></a><h2 id="undefined1-0-1-alpha-5-2018-02-04-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-getting-started@1.0.1-alpha.4...@loopback/example-getting-started@1.0.1-alpha.5">1.0.1-alpha.5</a> (2018-02-04)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-getting-started</p> <p><a name="1.0.1-alpha.4"></a></p> <a name="1-0-1-alpha-4-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-1-0-1-alpha-3-loopback-example-getting-started-1-0-1-alpha-4-2018-01-30"></a><h2 id="undefined1-0-1-alpha-4-2018-01-30-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-getting-started@1.0.1-alpha.3...@loopback/example-getting-started@1.0.1-alpha.4">1.0.1-alpha.4</a> (2018-01-30)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-getting-started</p> <p><a name="1.0.1-alpha.3"></a></p> <a name="1-0-1-alpha-3-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-1-0-1-alpha-2-loopback-example-getting-started-1-0-1-alpha-3-2018-01-29"></a><h2 id="undefined1-0-1-alpha-3-2018-01-29-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-getting-started@1.0.1-alpha.2...@loopback/example-getting-started@1.0.1-alpha.3">1.0.1-alpha.3</a> (2018-01-29)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-getting-started</p> <p><a name="1.0.1-alpha.2"></a></p> <a name="1-0-1-alpha-2-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-1-0-1-alpha-1-loopback-example-getting-started-1-0-1-alpha-2-2018-01-26"></a><h2 id="undefined1-0-1-alpha-2-2018-01-26-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-getting-started@1.0.1-alpha.1...@loopback/example-getting-started@1.0.1-alpha.2">1.0.1-alpha.2</a> (2018-01-26)</h2> <p><strong>Note:</strong> Version bump only for package @loopback/example-getting-started</p> <p><a name="1.0.1-alpha.1"></a></p> <a name="1-0-1-alpha-1-https-github-com-strongloop-loopback-next-compare-loopback-example-getting-started-1-0-1-alpha-0-loopback-example-getting-started-1-0-1-alpha-1-2018-01-26"></a><h2 id="undefined1-0-1-alpha-1-2018-01-26-"><a href="https://github.com/strongloop/loopback-next/compare/@loopback/example-getting-started@1.0.1-alpha.0...@loopback/example-getting-started@1.0.1-alpha.1">1.0.1-alpha.1</a> (2018-01-26)</h2> <a name="bug-fixes-6"></a><h3 id="undefinedbug-fixes">Bug Fixes</h3> <ul> <li>apply source-maps to test errors (<a href="https://github.com/strongloop/loopback-next/commit/76a7f56">76a7f56</a>), closes <a href="https://github.com/strongloop/loopback-next/issues/602">#602</a></li> <li>make mocha self-contained with the source map support (<a href="https://github.com/strongloop/loopback-next/commit/7c6d869">7c6d869</a>)</li> </ul> <p><a name="1.0.1-alpha.0"></a></p> <a name="1-0-1-alpha-0-2018-01-19"></a><h2 id="undefined1-0-1-alpha-0-2018-01-19-">1.0.1-alpha.0 (2018-01-19)</h2> <a name="bug-fixes-7"></a><h3 id="undefinedbug-fixes">Bug Fixes</h3> <ul> <li><strong>example-getting-started:</strong> fix &quot;extends&quot; path to point to <a href="https://github.com/loopback">@loopback</a>/build module (<a href="https://github.com/strongloop/loopback-next/commit/5b37148">5b37148</a>)</li> </ul> <a name="features-7"></a><h3 id="undefinedfeatures">Features</h3> <ul> <li><strong>example-getting-started:</strong> migrate into monorepo (<a href="https://github.com/strongloop/loopback-next/commit/9478d8b">9478d8b</a>)</li> </ul> <a name="loopback-example-todo"></a><h1 id="undefined-loopback-example-todo">@loopback/example-todo</h1> <p>This is the basic tutorial for getting started with Loopback 4!</p> <a name="overview"></a><h2 id="undefinedoverview">Overview</h2> <p>This tutorial demonstrates how to create a basic API for a todo list using LoopBack 4.</p> <a name="setup"></a><h2 id="undefinedsetup">Setup</h2> <p>You&#39;ll need to make sure you have some things installed:</p> <ul> <li><a href="https://nodejs.org/en/">Node.js</a> at v8.x or greater</li> </ul> <p>Additionally, this tutorial assumes that you are comfortable with certain technologies, languages and concepts.</p> <ul> <li>JavaScript (ES6)</li> <li><a href="http://www.restapitutorial.com/lessons/whatisrest.html">REST</a></li> </ul> <p>Lastly, you&#39;ll need to install the LoopBack 4 CLI toolkit:</p> <pre><code class="lang-sh">npm i -g @loopback/cli </code></pre> <a name="tutorial"></a><h2 id="undefinedtutorial">Tutorial</h2> <p>To follow this tutorial, begin with the <a href="http://loopback.io/doc/en/lb4/todo-tutorial-scaffolding.html">Create your app scaffolding</a> section.</p> <a name="steps"></a><h3 id="undefinedsteps">Steps</h3> <ol> <li><a href="http://loopback.io/doc/en/lb4/todo-tutorial-scaffolding.html">Create your app scaffolding</a></li> <li><a href="http://loopback.io/doc/en/lb4/todo-tutorial-juggler.html">Adding legacy juggler</a></li> <li><a href="http://loopback.io/doc/en/lb4/todo-tutorial-model.html">Add your Todo model</a></li> <li><a href="http://loopback.io/doc/en/lb4/todo-tutorial-datasource.html">Add a datasource</a></li> <li><a href="http://loopback.io/doc/en/lb4/todo-tutorial-repository.html">Add a repository</a></li> <li><a href="http://loopback.io/doc/en/lb4/todo-tutorial-controller.html">Add a controller</a></li> <li><a href="http://loopback.io/doc/en/lb4/todo-tutorial-putting-it-together.html">Putting it all together</a></li> </ol> <a name="try-it-out"></a><h2 id="undefinedtry-it-out">Try it out</h2> <p>If you&#39;d like to see the final results of this tutorial as an example application, follow these steps:</p> <ol> <li><p>Run the <code>lb4 example</code> command to select and clone the todo repository:</p> <pre><code class="lang-sh">$ lb4 example ? What example would you like to <span class="hljs-built_in">clone</span>? (Use arrow keys) ❯ todo: Tutorial example on how to build an application with LoopBack 4.. hello-world: A simple hello-world Application using LoopBack 4 <span class="hljs-built_in">log</span>-extension: An example extension project <span class="hljs-keyword">for</span> LoopBack 4 rpc-server: A basic RPC server using a made-up protocol. </code></pre> </li> <li><p>Jump into the directory and then install the required dependencies:</p> <pre><code class="lang-sh"><span class="hljs-built_in">cd</span> loopback4-example-todo &amp;&amp; npm i </code></pre> </li> <li><p>Finally, start the application!</p> <pre><code class="lang-sh"> $ npm start Server is running on port 3000 </code></pre> </li> </ol> <p>Feel free to look around in the application&#39;s code to get a feel for how it works, or if you&#39;re still interested in learning how to build it step-by-step, then continue with this tutorial!</p> <a name="stuck"></a><h3 id="undefinedstuck-">Stuck?</h3> <p>Check out our <a href="https://gitter.im/strongloop/loopback">Gitter channel</a> and ask for help with this tutorial!</p> <a name="bugs-feedback"></a><h3 id="undefinedbugs-feedback">Bugs/Feedback</h3> <p>Open an issue in <a href="https://github.com/strongloop/loopback-next">loopback-next</a> and we&#39;ll take a look!</p> <a name="contributions"></a><h2 id="undefinedcontributions">Contributions</h2> <ul> <li><a href="https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md">Guidelines</a></li> <li><a href="https://github.com/strongloop/loopback-next/issues/110">Join the team</a></li> </ul> <a name="tests"></a><h2 id="undefinedtests">Tests</h2> <p>Run <code>npm test</code> from the root folder.</p> <a name="contributors"></a><h2 id="undefinedcontributors">Contributors</h2> <p>See <a href="https://github.com/strongloop/loopback-next/graphs/contributors">all contributors</a>.</p> <a name="license"></a><h2 id="undefinedlicense">License</h2> <p>MIT</p> </div> <div class="intentionally-left-blank"></div> </div> </div> <script src="js/vendor/jquery-1.10.1.min.js"></script> <script src="js/vendor/jquery.scrollTo-1.4.3.1.js"></script> <script src="js/vendor/bootstrap.min.js"></script> <script src="js/main.js"></script> </body> </html>