Microsoft/alguidelines
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

deploy: 13beb2fee6

Browse source
This commit is contained in:
TheDoubleH 2022-02-27 19:23:53 +00:00
parent 7006c9a415
commit d5790b8abb
199 changed files with 1035 additions and 737 deletions
Download patch file Download diff file Expand all files Collapse all files

25
docs/bestpractices/api-page/index.html
View file

@ -24,14 +24,14 @@ Description API pages are different from UI pages. They require different proper
Separate API app Page properties Versioning Field properties Default fields Separate API app It’s a good practice to develop API pages in a separate app instead of combining them in a solution.">
<meta property="og:type" content="article">
<meta property="og:url" content="https://alguidelines.dev/docs/bestpractices/api-page/"><meta property="og:image" content="https://alguidelines.dev/images/og-image-fission.png"><meta property="article:section" content="docs">
<meta property="article:modified_time" content="2022-02-26T20:59:34+01:00"><meta property="og:site_name" content="alguidelines.dev - Business Central Design Patterns">
<meta property="article:modified_time" content="2022-02-27T11:23:04-08:00"><meta property="og:site_name" content="alguidelines.dev - Business Central Design Patterns">
<meta itemprop=name content="API Page / Query">
<meta itemprop=description content="Created by Arend-Jan Kauffmann, Described by Arend-Jan Kauffmann
Description API pages are different from UI pages. They require different properties and don&rsquo;t behave the same. Because API pages are used for integration with external applications, they should be treated as contracts. To achieve this, the following topics are important.
Separate API app Page properties Versioning Field properties Default fields Separate API app It&rsquo;s a good practice to develop API pages in a separate app instead of combining them in a solution.">
<meta itemprop=dateModified content="2022-02-26T20:59:34+01:00">
<meta itemprop=dateModified content="2022-02-27T11:23:04-08:00">
<meta itemprop=wordCount content="780"><meta itemprop=image content="https://alguidelines.dev/images/og-image-fission.png">
<meta itemprop=keywords content><meta name=twitter:card content="summary_large_image">
<meta itemprop=keywords content="AL,API,"><meta name=twitter:card content="summary_large_image">
<meta name=twitter:image content="https://alguidelines.dev/images/og-image-fission.png">
<meta name=twitter:title content="API Page / Query">
<meta name=twitter:description content="Created by Arend-Jan Kauffmann, Described by Arend-Jan Kauffmann
@ -66,7 +66,7 @@ Description API pages are different from UI pages. They require different proper
</li>
</ul>
</div>
<div class="navbar-nav d-none d-lg-block"><input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.15d6fe3997de27ba07da8d70abc12638.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<div class="navbar-nav d-none d-lg-block"><input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.9ab69a84696ad11cb17318558d9706e3.json data-offline-search-base-href=/ data-offline-search-max-results=10>
</div>
</nav>
</header>
@ -77,7 +77,7 @@ Description API pages are different from UI pages. They require different proper
<div id=td-sidebar-menu class=td-sidebar__inner>
<div id=content-mobile>
<form class="td-sidebar__search d-flex align-items-center">
<input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.15d6fe3997de27ba07da8d70abc12638.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.9ab69a84696ad11cb17318558d9706e3.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<button class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fas fa-bars" type=button data-toggle=collapse data-target=#td-section-nav aria-controls=td-docs-nav aria-expanded=false aria-label="Toggle section navigation">
</button>
</form>
@ -543,8 +543,8 @@ Description API pages are different from UI pages. They require different proper
<div class="taxonomy taxonomy-terms-cloud taxo-tags">
<h5 class=taxonomy-title>Tag Cloud</h5>
<ul class=taxonomy-terms>
<li><a class=taxonomy-term href=https://alguidelines.dev/tags/al/ data-taxonomy-term=al><span class=taxonomy-label>AL</span><span class=taxonomy-count>28</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/tags/api/ data-taxonomy-term=api><span class=taxonomy-label>API</span><span class=taxonomy-count>2</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/tags/al/ data-taxonomy-term=al><span class=taxonomy-label>AL</span><span class=taxonomy-count>29</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/tags/api/ data-taxonomy-term=api><span class=taxonomy-label>API</span><span class=taxonomy-count>3</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/tags/c/al/ data-taxonomy-term=c/al><span class=taxonomy-label>C/AL</span><span class=taxonomy-count>136</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/tags/decoupling/ data-taxonomy-term=decoupling><span class=taxonomy-label>Decoupling</span><span class=taxonomy-count>2</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/tags/extendability/ data-taxonomy-term=extendability><span class=taxonomy-label>Extendability</span><span class=taxonomy-count>3</span></a></li>
@ -580,6 +580,13 @@ Description API pages are different from UI pages. They require different proper
<div class=td-content>
<h1>API Page / Query</h1>
<header class=article-meta>
<div class="taxonomy taxonomy-terms-article taxo-tags">
<h5 class=taxonomy-title>Tags:</h5>
<ul class=taxonomy-terms>
<li><a class=taxonomy-term href=https://alguidelines.dev/tags/al/ data-taxonomy-term=al><span class=taxonomy-label>AL</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/tags/api/ data-taxonomy-term=api><span class=taxonomy-label>API</span></a></li>
</ul>
</div>
<div class="taxonomy taxonomy-terms-article taxo-categories">
<h5 class=taxonomy-title>Categories:</h5>
<ul class=taxonomy-terms>
@ -711,8 +718,8 @@ All APIs pages apply the behavior to first specify all field values and then ins
</span><span style=color:#f8f8f8;text-decoration:underline></span>}<span style=color:#f8f8f8;text-decoration:underline>
</span></code></pre></div>
<div class="text-muted mt-5 pt-3 border-top">
Last modified February 26, 2022: <a href=https://github.com/microsoft/alguidelines/commit/2ec683b653ac49d00073c9d61206f1bb508998ba>New guideline API page (2ec683b6)</a>
by Arend-Jan Kauffmann
Last modified February 27, 2022: <a href=https://github.com/microsoft/alguidelines/commit/13beb2fee64a5fba485e3540b12ab5451fb7e59d>Correct Typo (13beb2fe)</a>
by Henrik Helgesen
</div>
</div>
</main>