Skip to content

apimap/javascript-api-library

Apimap.io JavaScript API Library

🎉 Welcome 🎉

This is the home of the Apimap.io project, a freestanding solution to keep track of all functionality a company provides through an API. It is a push based system, connected with your build pipeline or manually updated using our CLI.

Application programming interface (API): Point of functional integration between two or more systems connected through commonly known standards

Why is this project useful? Lost track of all the API functionality provided inside your organization? Don't want to be tied to an API proxy or management solution? The Apimap.io project uploads, indexes and enables discoverability of all your organizations APIs. We care about the source code, removing the limitation of where the API is hosted and how your network is constructed.

Telenor Open Source Project

This project is a part of the Open Source initiatives in Telenor. Read more about our company at http://www.telenor.com

TelenorLogo

Table of Contents

I want to know more of the technical details and implementation guides: DEVELOPER.md

Project Components


This is a complete software solution consisting of a collection of freestanding components. Use only the components you find useful, create the rest to custom fit your organization.

  • A Developer Portal with wizards and implementation information
  • A Discovery Portal to display APIs and filter search results
  • An API to accommodate all the information
  • An Orchestra API to manage access rights and SSO integration
  • A Jenkins plugin to automate information parsing and upload
  • A GitHub Action to automate information parsing and upload
  • A CLI to enable manual information uploads

Run


This code library has been developed to share integration code between the Apimap APIs and the different front-end portals.

Requirements`

None

Contributing


Read howto contribute to this project.

About

API clients to use the REST apis

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages