@skywardapps/popcorn-api
TypeScript icon, indicating that this package has built-in type declarations

0.9.1 • Public • Published

Popcorn

numget npm

Overview

Popcorn is a communication protocol on top of a RESTful API that allows requesting clients to identify individual fields of resources to include when retrieving the resource or resource collection.

It allows for a recursive selection of fields, allowing multiple calls to be condensed into one.

See specifications for the call-response model on GitHub

Getting Started

This presumes you have a RESTful web-api you are building, utilizing Typescript for typing and inversify-express-utils to scaffold your API endpoints on top of express.

Requirements

  • InversifyJS & inversify-express-utils
  • Typescript
  • Express

Authors

Skyward Skyward App Company, LLC

Technologies

TypeScript Express.js NodeJS

GitHub NPM

Package Sidebar

Install

npm i @skywardapps/popcorn-api

Weekly Downloads

2

Version

0.9.1

License

MIT

Unpacked Size

12.3 kB

Total Files

7

Last publish

Collaborators

  • nicholasmtelliott
  • emilyragan