apinf/platform

Apinf - Open source API management platform with multi proxy and protocol support

APInf API Management Framework

Table of Contents generated with DocToc

• Docker image
• Development status
• Automated testing
• Nightly build
• Contributing
• Links

Docker image

Docker images are hosted in Dockerhub: https://hub.docker.com/r/apinf/platform/tags

APInf API management

The APInf platform offers a comprehensive tool for API management. Building on APInf Umbrella, it provides enhanced user interface features for API managers and consumers alike.

For API consumers APInf provides simple key management, key usage analytics and API discovery along with API documentation. Managers have simplified workflow for common tasks, such as key management, rate limiting and viewing API usage analytics.

Why to use? If you have APIs and you are looking for additional control on API access, API documentation and analytics in one package, this is for you.

📄 Site	🎓 Academy	🐳 Docker Hub	🎯 Roadmap

Development status

Testing

For automated testing we use Sauce Labs.

Nightly build

You can preview our latest version at nightly.apinf.io. Feel free to register an account and test things out.

Contributing

Please review our Contributor Guide for details on how to get involved with the project.

Please follow guidelines for community involvement in our Code of Conduct

Links

More about APInf: apinf.com.

APInf saas service: apinf.io.

License

APInf is licensed under the EUPL-1.1 License.

FIWARE GE

APInf API Management Framework is a FIWARE Generic Enabler. Therefore, it can be integrated as part of any platform “Powered by FIWARE”. FIWARE is a curated framework of open source platform components which can be assembled together with other third-party platform components to accelerate the development of Smart Solutions.

You can find more info at the FIWARE developers website and the FIWARE website.

The complete list of FIWARE GEs and Incubated FIWARE GEs can be found at the FIWARE Catalogue

© 2019 APInf Oy

platform's Issues

Find contact persons from COSS for Mindtrek planning

Research API umbrella web features

Get to know more about API Umbrella web. Take notes and share them on the API Umbrella Github wiki, so the community benefits. Also, note the structure of the API Umbrella AII.

Add Github authentication option

Add Github user authentication source to boilerplate project. Developers may want to authenticate using their existing Github accounts.

Deliverables

• List of options for Meteor Github authentication
• Demonstration of Meteor Github authentication

Filters

Document Consumer personas

Analytics

Remove Facebook AppID and secret key from dev.json

There are Facebook credentials in dev.json that may be advisable to remove. Just a note :-)

Determine any additional, necessary fields for user profile

Look at existing user profile fields. Document and wireframe any additional fields that would be required for our project.

Deliverables

• Design document - list current and proposed fields with descriptions
• Wireframe - demonstrate the layout options for new fields
• Schema - add one or more new fields to user profile schema

As a product owner, I want to define initial target requirements, so that I can focus development efforts

Create baseline technical specification

Test API Umbrella Admin API

Deliverables

• Obtain Admin API authentication key
• Access Admin API via authentication key (JSON response)

Create follow-up plan for project

Consider whether to add stakeholder prioritization to communications plan

Create user stories

Find documentation about API Umbrella API.

In order to consider out development platform strategy, we need to know how to build with existing API Umbrella capabilities. To this end, we might benefit by using the API Umbrella internal API.

Task

Find documentation about the API Umbrella API.

Integrate authentication with API Umbrella Gatekeeper

Expand mvp specification

Create section describing each MVP feature. Include basic details about functionality, user roles, user interface.

As a product owner, I want personas to be defined, so that I know for whom to create user stories

Change boilerplate branding to reflect Apinf purposes

Brainstorm session about personas

Dashboard

Authentication

Organize Nick's travel for Mindtrek

Create several (3 or more) API Management UI wireframes

Create multiple wireframe concepts to explore the design space for an API Management interface. Initial wireframes should be low fidelity, just enough detail to communicate design ideas.

Tasks

• Create 3 or more distinct wireframe designs
• Attach designs to the planning document
• Get feedback for designs
• Combine desirable features into one or more secondary design mock-ups

User Stories

As a project manager,
I want to get an idea of the possibilities for an API management
so that I can have confidence we are considering among many possible solutions

As a software developer,
I want to see multiple wireframes
so that I can be part of the design process

As an end user
I want to see multiple layout and design possibilities
so I know that the design process explored multiple possible solutions

As a community member
I want to see the design process documents
so that I can participate in design decisions

As a designer
I want to produce multiple design possibilities
so that I explore the design space and can realize the multiple possibilities for this design

Brainstorming session for Owner Personas

Deliverables

• Conduct brainstorm session
• Document personas

Find filterable table package for Meteor

Usera may want to filter dashboard data, to display certain records.

Audit data table options for Meteor.

Desirable features:

• Filtering
  • Multi-criteria filtering
• Pagination
• Sorting
• Customization
  • Add/remove columns
  • Aesthetic display

Deliverables

• List of options for filterable table
• Demonstration of each option

Create several (3 or more) dashboard wireframe examples

Create multiple wireframe concepts to explore the design space for an API consumer dashboard interface.

User Stories

As a project manager,
I want to get an idea of the possibilities for an API consumer dashboard
so that I can have confidence we are considering among many possible solutions

As a software developer,
I want to see multiple dashboard wireframes
so that I can be part of the design process

As an end user
I want to see multiple dashboard layout and design possibilities
so I know that the design process explored multiple possible solutions

As a community member
I want to see the design process documents
so that I can participate in design decisions

As a designer
I want to produce multiple design possibilities
so that I explore the design space and can realize the multiple possibilities for this design

Create API Lifecycle document

Create a document describing key stages in API Lifecycle Management.

Documentation browser

Create an interface or frame for displaying Swagger files.

User story: As Minh (API consumer), I want to access API documentation.

Definition of done:

• Add Swagger source files to project in location determined in #160(?)
• Create "Upload Swagger file" functionality.
  • Create basic template for Swagger file upload.
  • Add Bootstrap button to Swagger file upload template.
  • Create file system collection to store Swagger files.
  • Create template logic e.g. helper and event to upload file, when button is clicked.
  • Create foreign key relationship between API backend and Swagger file.
  • Create collection helper to retrieve Swagger file from API backend.

Set up scaffold

Create Roadmap document

Create the initial document and structure for our project Roadmap. Sections include Sprint Zero and a general ideas section for ideas not assigned to a sprint.

Set up project repository

Document API Umbrella integration options

We need to know options for integrating our development with the API Umbrella components. Document the integration options along with pros/cons for each.

Deliverable

• Wiki page: Integration Options

Populate project backlog

Add HTML table to admin dashboard using bootstrap semantics

Create a basic HTML table in the administrator interface. Use bootstrap CSS semantics to markup the table. Use as little custom CSS as possible.

Create API design and management tools document

Look at existing API design and management tools. Compare common features, UI design, documentation, and underlying technology choices.

Specify recruitment needs

Identify technologies to be used and gaps in skills/resources. Make a suggestio to management regarding resource allocation.

Display Admin API data in boilerplate UI

Get structured data from API Umbrella Admin API and display it in a table on the APInf dashboard.

Depends on #42 and #11

User Profile

Research API Umbrella Gatekeeper

Complete stakeholder analysis in communications plan

Complete communication plan for each stakeholder

Create communication plan document

Create a documennt describing tools and procedures for team communication, review process, etc..

Plannning brainstorm session

Learn about Mongo/Meteor aggregations.

The analytics and other dashboard features may rely on aggregation functions such as sum, average, filtering, etc. Get a better understanding of how to use Mongo aggregations in Meteor.

Improve API Umbrella API Scope documentation

Document the API Umbrella API Scope feature, based on API Umbrella Issue #130.

Queries

Custom APIs

User story: As Minh (API consumer), I want to create custom API's mixing sources.

Create brand book for Apinf

Modify branding text, colors, icons, logo, image(s), social media links, and screen captures of Admin UI.

Deliverable

• Design document - Outlook (typography, color scheme, logo, tone, etc)

Study Smooth CoffeeScript ebook