Skip to content

Latest commit

 

History

History
70 lines (40 loc) · 4.58 KB

README.md

File metadata and controls

70 lines (40 loc) · 4.58 KB
Raw

APIOps® Cycles

What is this?

The APIOps® Cycles is a set of tools and methods for designing API Management compatible API's with Clear business orientation and best practice architecture patters.

APIOps® method uses modern and proven frameworks with a twist of our experience to the them for APIs. All methods have a Lean management base: DevOps (wikipedia), Business Model Canvas (wikipedia), Value Proposition Canvas, Lean Startup (wikipedia), Minimum Viable Architecture and API Model Canvas. Afore mentioned frameworks, tools and methods have been re-interpreted to create the APIOps® Cycles.

APIOps® Cycles is created in collaboration with open non-profit APIOps.net Community and Digia Plc. APIOps® is a registered trademark of APInf Oy. Templates and method is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License (CC BY-SA 4.0)

How do you use

The APIOps® Cycles model can be used in various ways. Here's a few obvious examples:

  • Use the model to help customers with entering API economy and adopt standardized processes in API development and maintenance to maximise results and to minimize costs.
  • Use the model in API management and alike tool development as a process model.

Where is the published site

You can access the content in pretty format from cycles.apiops.net

Contributors

We welcome all new contributions which help us to iterate APIOps Cycles model further. All the contributors are listed in separate file.

How do you contribute

There are multiple ways to contribute, but here's a few:

  • Tweet about the APIOps® Cycles model. Follow @APIOps handle to get latest news.
  • Write blogs about it. You're welcome to use APIOps® (Medium) blog as well.
  • Discuss about it in community boards to find new viewpoints (and provide link here).
  • Build new tools to support usage of APIOps® Cycles. We are happy to include open source solutions under APIOps® organisation in Github.
  • Use the model or parts of it and share experiences in APIOps meetups. Local groups can be found from apiops.net
  • Submit an issue (new feature or bug). More details about submitting issue can be found below.
  • Those not so familiar with Github can join APIOps® Facebook group and discuss ideas there.

How do you report issues

Before submitting new issue, please check out the previous issues in case your topic has alredy been started by someone else. If you can't find any similat issue, begin a new one. A good issue normally takes the following into account:

Context: explain the conditions which led you to write this issue.

For example: “Since we’ve tried the model with a few cases, we could not find a solution to this.”

Problem or idea: the context should lead to something, an idea or a problem that you’re facing.

For example: “We’ve had no way of easily seeing the performance impact before releasing our changes to production.”

Solution or next step: this where you move forward.

You can engage others (request feedback), assign somebody else to the issue, or simply leave it for further investigation, but you absolutely need to propose a next step towards solving the issue.

A few more things:

  • Keep titles short and descriptive.
  • Remain clear and concise.
  • Include the right people in your discussion.
  • Format your messages.
  • Add links to you references.

About pages

The site is built with Jekyll from the content in Markdown files. Every commit to master -branch triggers update automatically to github built-in jekyll static site generator and after successfull commit in about 1-5 minutes the site is built.

You can use the editor on GitHub to maintain and preview the content for your website in Markdown files

For more details see GitHub Flavored Markdown.