npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

backstage-plugin-api-linter

v1.0.12

Published

API Linter is a quality assurance tool that checks the compliance of API's specifications to Zalando's API rules.

Downloads

430

Readme

Node.js CI

backstage-plugin-api-linter

Welcome to the Backstage Plugin API Linter!

API Linter is a quality assurance tool. Its main purpose is to check the compliance of API's specifications to Zalando's API rules.

The plugin's UI is able to lint the API specification in OpenAPI format. The result of the linting is a set of Violations. A violation contains information about the violated rule, its severity, and path of the violation in the specification document.

This plugin is an UI using Zally as a backend.

Getting started

Add the plugin to your frontend app:

cd packages/app && yarn add backstage-plugin-api-linter

On your app-config.yaml configure the proxy endpoint of the plugin.

proxy:
  "/api-linter":
    target: <your-zally-instance-url>
    allowedHeaders: ["Authorization"]

Using ApiLinter:

First export the plugin on app/App.tsx file:

export { APILinterPlugin } from 'backstage-plugin-api-linter';

Then use the component on your application!

With tabbed layout:

<TabbedLayout>
  <TabbedLayout.Route path="/" title="another title">
    <AnotherExampleComponent />
  </TabbedLayout.Route>
  <TabbedLayout.Route path="/linter" title="LINTER" data-id="api-linter">
    <APILinter />
  </TabbedLayout.Route>
</TabbedLayout>

Content

<Content>
  <APILinter />
</Content>

How to track user behaviour

We are currently using Google Analytics for tracking the user behavior. To track the plugin you can pass your google Analytics functions as props to the APILinter component.

<APILinter
  sendEvent={PluginTracking.sendEvent}
  sendPageView={PluginTracking.sendPageView}
  eventInfo={{
    plugin: "api-linter",
    eventCategory: "API linter page",
  }}
/>

where

  • sendEvent is:
function sendEvent(args: IEventTracking) {
  GoogleAnalytics.event({
    plugin: args.plugin,
    category: args.eventCategory,
    action: args.eventAction,
    label: args.eventLabel,
  });
}
type IEventTracking {
  plugin: string;
  eventLabel: string;
  eventAction: string;
  eventCategory: string;
}
  • sendPageView is:
function sendPageView() {
  GoogleAnalytics.set({ page: window.location.pathname });
  GoogleAnalytics.pageview(window.location.pathname + window.location.search);
}
  • eventInfo is:
type ICommonEventInfo {
  plugin: string;
  eventCategory: string;
};

eventInfo will be the same for all events

Tracked events are:

  • page view
  • clicks on Zalando's guideline link
  • clicks on import url
  • hover on url input
  • validate by url
  • cancel validate by url
  • clicks on schema input
  • validate by schema input
  • clicks to view rules
  • clicks on individual rule cards
  • clicks on tags (must, should, may)
  • clicks on links on rule cards
  • clicks on validate by schema button
  • hovers on api badge
  • hovers on api badge text