search

okffi / open-api-definition

Community governed definition of open API
http://okffi.github.io/open-api-definition/
Creative Commons Zero v1.0 Universal
7 stars 7 forks source link

Määritelmän suhde "api managementtiin" --> Mikä näistä asioista vaikuttaa siihen, onko API avoin vai ei #35

Open Mygee opened 8 years ago

Mygee commented 8 years ago

Avaan keskustelun tästä aiheesta. Tyypillisesti API managementissa hallitaan esim näitä: http://www.developereconomics.com/api-management-tools-how-to-find-the-one-for-you/ Eli:

  1. Documentation – Sounds boring, right? Still, one of the most common problems of developers is figuring out how an API works. Development time is too precious to waste in trial and error of an undocumented API. An API management service has to provide an easy way to read the documentation and enable developers to “try before they buy”. In some cases it is even possible to provide interactive documentation. Simplicity and usability are the keys!
  2. Analytics and Statistics – It is critical to understand how people use your API and get insights for your business.
  3. Deployment – Should be flexible and support public or private clouds, on-premises implementations, or combinations.
  4. Developer engagement – Engaging with your API consumers, developer or partners is important. Getting an easily accessible developer portal will significantly facilitate onboarding. Sandbox environment – This feature will increase both the value of an API and its adoption rate. What better than being able to develop and test your code. Traffic management and caching abilities.
  5. Security – APIs carry sensitive data, so it is important to protect the exposed information. The service has to at least provide identity and access management for users and developers.
  6. Monetization – Provide the capability to monetize your API.
  7. Availability – Should be available, scalable and redundant. An API environment can become demanding and the service should be able to deal with any kind of errors, problems or temporary traffic spikes.
  8. Support of Legacy systems.
apoikola commented 8 years ago

samoin, kuin suhteessa tiedon semantiikkaan ( https://github.com/okffi/open-api-definition/issues/37 ), niin ohjaavana kysymyksenä pitää olla, että:

Mikä näistä asioista vaikuttaa siihen, onko API avoin vai ei?

Lisäksi se, mikä pitää saada kristalloitua määritelmään on, että mikä on avoin rajapinta ja mikä on avoimen rajapinnan toteuttava rajapintapalvelu (rajapinnan yksi implementaatio). 1.0 versiossa ei olla paljoakaan otettu kantaa rajapintapalveluihin ja monet api management jutut koskevat rajapintapalveluja.