0.9.1 • Published 2 years ago

@skywardapps/popcorn-api v0.9.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

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