at-your-service
TypeScript icon, indicating that this package has built-in type declarations

0.3.1 • Public • Published

MIT License npm npm

npm


Logo

at-your-service


A developer tool for API observability on the browser. Generate OpenAPI specifications and code from network traffic

Designed for ease of use. No need to integrate with existing code


View the Live Demo

Report Bug · View on npm · YouTube Demo



Table of Contents
  1. About the Project and Why
  2. Features
  3. Getting Started
  4. How It Works
  5. Contributing
  6. Limitations
  7. License

About the Project and Why

npm

This tool is designed to help tackle problems that arise from a lack of awareness on API behaviour.

It records network requests under the hood using a service worker proxy. As the tool makes observations of network traffic over time, it learns the structure of the underlying API.

(back to top)

Features

  • Spec gen: autogenerate OpenAPI 3.1 specifications from network traffic
  • Code gen: convert network response bodies into code for 10+ languages including TypeScript, Python, and JSON Schema
  • API Observability: explore the network layer with enhanced tooling
  • Easy installation: designed to plug in and go with an existing application

(back to top)

Getting Started

at-your-service features a CLI tool that places its service worker file into a directory. You likely wish to place this in public or static. See more information here on common locations for static files.

The service worker must be served from the root of your site. Once this is installed run the start script in your application code.

  1. Install the npm package

    npm install -D at-your-service@latest
  2. Add service worker to your public, static, or otherwise root directory

    npx at-your-service@latest <directory>
  3. Run the start script in your application

    import { startAtYourService } from "at-your-service";
    
    startAtYourService();
  4. A button to open the drawer will be visible on your site

  5. You can view copied OpenAPI 3.1 specifications in editor-next.swagger.io. At the time of writing, you need to manually change the version from 3.1.0 to 3.0.0 after pasting the specification. Support for the new version of the specifcation is an ongoing process

(back to top)

How It Works

More information on the rationale, functionality, and architecture of the tool can be found here.

(back to top)

Contributing

A development environment exists in demo, which when built is the landing page for the library.

If you have a suggestion that would make this better, please fork the repo and create a pull request.

(back to top)

Limitations

The library creates specifications that are only as accurate as the underlying observations. If your application relies on a response body that has not been observed, then type information for it will not be available.

Overall the intent is to produce a best guess that reveals API behaviour. This will never be a replacement for proper documentation.

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Package Sidebar

Install

npm i at-your-service

Weekly Downloads

7

Version

0.3.1

License

MIT

Unpacked Size

2.82 MB

Total Files

54

Last publish

Collaborators

  • andrew_walsh