No | Aspect | Description |
---|---|---|
1 | API consumers | Developers building enterprise applications that send text messages. |
2 | Core benefit | Enables API consumers send and receive text messages. |
3 | Business capabilities | 1) Send messags 2) Receive messages 3) Manage contacts 4) Query metadata information on sent and received messags 5) Create message templates |
4 | API product manger | John Smith |
5 | API solution | REST API. Connects to the Messaging, Contacts, Notification and Template microservices. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
openapi: 3.0.0 | |
info: | |
title: Cursor Pagination API | |
version: 1.0.0 | |
paths: | |
/items: | |
get: | |
summary: Get a list of items | |
parameters: | |
- name: cursor |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
const { RuleTester } = require('eslint'); | |
const openApiParser = require('openapi-parser'); | |
// Define the linting rule | |
const rule = { | |
meta: { | |
docs: { | |
description: 'Ensure an API operation has at most one 2xx response', | |
category: 'Best Practices', | |
recommended: true, |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
const fs = require('fs'); | |
const path = require('path'); | |
function printFileNames(directory) { | |
fs.readdir(directory, (err, files) => { | |
if (err) { | |
console.error(`Error reading directory: ${err}`); | |
return; | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
const fs = require('fs'); | |
const yaml = require('js-yaml'); | |
function listEndpoints(openapiFile) { | |
try { | |
const openapiData = yaml.safeLoad(fs.readFileSync(openapiFile, 'utf8')); | |
const paths = openapiData.paths || {}; | |
const endpoints = []; | |
for (const path in paths) { |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# API Design Guidelines | |
# Introduction | |
The PayPal platform is a collection of reusable services that encapsulate well-defined business capabilities. Developers are encouraged to access these capabilities through Application Programming Interfaces (APIs) that enable consistent design patterns and principles. This facilitates a great developer experience and the ability to quickly compose complex business processes by combining multiple, complementary capabilities as building blocks. | |
PayPal APIs follow the [RESTful][0] architectural style as much as possible. To support our objectives, we have developed a set of rules, standards, and conventions that apply to the design of RESTful APIs. These have been used to help design and maintain hundreds of APIs and have evolved over several years to meet the needs of a wide variety of use cases. | |
We are sharing these guidelines to help propagate good API design practices in general. We have pulled extensively from the broader community and believe that it is importan |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Copied from https://github.com/columbia-it/django-jsonapi-training/blob/master/docs/schemas/openapi.yaml | |
openapi: 3.0.2 | |
info: | |
version: 1.2.0 | |
title: myapp | |
description: '![alt-text](https://cuit.columbia.edu/sites/default/files/logo/CUIT_Logo_286_web.jpg | |
"CUIT logo") | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JSONAPIObject: | |
description: Includes the current JSON:API version for this specification as well as optional meta information | |
type: object | |
required: | |
- version | |
properties: | |
version: | |
type: string | |
default: '1.0' | |
example: '1.0' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Tue Apr 7 19:37:54 UTC 2020 |
Copyright © 2016-2018 Fantasyland Institute of Learning. All rights reserved.
A function is a mapping from one set, called a domain, to another set, called the codomain. A function associates every element in the domain with exactly one element in the codomain. In Scala, both domain and codomain are types.
val square : Int => Int = x => x * x
NewerOlder