Skip to content

Commit 14bf9be

Browse files
authored
Update index.html
minor fix
1 parent c285a95 commit 14bf9be

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,14 +171,14 @@
171171
<section>
172172
<h1>Abstract</h1>
173173
<p>
174-
This document presents a set of 53 metadata elements (organized into five categories) to usefully describe Web-based Application Programming Interfaces (APIs). These elements were developed by the Big Data to Knowledge (BD2K) API Interoperability Working Group, which conducted a survey of API metadata used in the real world. This group developed the smartAPI Specification as an extension of existing repositories such as Programmable Web, Biocatalogue, and available standards including Open API, schema.org, etc. The aim of the BD2K API Interoperability Working Group is to develop a strategy for maximizing interoperability and reuse of Web-based APIs. This specification aims to serve as a standard for API development that will facilitate the efficient communication among APIs and reduce development costs. The smartAPI Specification includes 19 metadata elements beyond those included in the Open API Initiative. The metadata elements are grouped into categories related to APIs, service providers, API operations, operation parameters, and operation responses. For each category, the metadata elements that are mandatory, recommended, or optional are described and illustrated by examples. The widespread adoption of the smartAPI Specification by the community promises to improve the efficiency and lower the costs of API development, promoting cross-API compatibility and resolving current challenges in API usage.
174+
This document presents a set of 53 metadata elements (organized into five categories) to usefully describe Web-based Application Programming Interfaces (APIs). These elements were developed by the Big Data to Knowledge (BD2K) API Interoperability Working Group, which conducted a survey of API metadata used in the real world. This group developed the smartAPI Specification as an extension of existing repositories such as Programmable Web, Biocatalogue, and available standards including Open API, schema.org, etc. The aim of the BD2K API Interoperability Working Group is to develop a strategy for maximizing interoperability and reuse of Web-based APIs. This specification aims to serve as a standard for API development that will facilitate the efficient communication among APIs and reduce development costs. The smartAPI Specification includes 19 metadata elements beyond those included in the Open API Initiative. The metadata elements are grouped into categories related to APIs, service providers, API operations, operation parameters, and operation responses. For each category, the metadata elements that are mandatory, recommended, or optional are described and illustrated by examples. The widespread adoption of the smartAPI Specification by the community promises to improve the efficiency and lower the costs of API development, promoting cross-API compatibility and resolving current challenges in API usage.
175175
</p>
176176
</section>
177177

178178
<section>
179179
<h1>Purpose of the smartAPI Specification</h1>
180180

181-
<p>The purpose of the smartAPI Specification is to establish a set of standards for the description of metadata elements and values for the description of Application Programming Interfaces (APIs). This document was produced by the Big Data To Knowledge (BD2K) API Interoperability Working Group, one of the NIH Commons Framework Pilot Working Groups. The BD2K API Interoperability Working Group first conducted a survey of API metadata found in existing repositories and guidelines (see Section 2: Survey of API Metadata in the Wild), and subsequently developed the smartAPI Specification as an extension of the Open API Initiative. The <a href="https://www.openapis.org/">Open API Initiative</a> aims to create, develop, and promote an API description format based on the <a href="http://swagger.io/specification/">Swagger Specification</a>.</p>
181+
<p>The purpose of the smartAPI Specification is to establish a set of standards for the description of metadata elements and values for the description of Application Programming Interfaces (APIs). This document was produced by the Big Data To Knowledge (BD2K) API Interoperability Working Group, one of the NIH Commons Framework Pilot Working Groups. The BD2K API Interoperability Working Group first conducted a survey of API metadata found in existing repositories and guidelines (see <a href="https://amrapalijz.github.io/smartapi/#survey-of-api-metadata-in-the-wild">Section 2</a>), and subsequently developed the smartAPI Specification as an extension of the Open API Initiative. The <a href="https://www.openapis.org/">Open API Initiative</a> aims to create, develop, and promote an API description format based on the <a href="http://swagger.io/specification/">Swagger Specification</a>.</p>
182182

183183
<p>The smartAPI Specification is intended to be a ‘living’ document that will continue to be revised and improved via the input of API development community members.</p>
184184
</section>

0 commit comments

Comments
 (0)