kurtseifried,

Any vendor with a web API that doesn't have #curl examples in the documents has a garbage API. Prove me wrong.

Aedius,
@Aedius@lavraievie.social avatar

@kurtseifried
You are not wrong, but you forgot vendor with curl examples that didn't work.
You got one like that recently at work it was a nightmare.

le0l,

@kurtseifried Right, but I feel it's even worse.
The APIs inflation, i.e. polynomial growth of their (ab)use in last years, hides more and more often a bad data structures design, that in modern & politically correct speaking is usually called "interoperability".

delfuego,

@kurtseifried Better still, tools like Stoplight Elements (https://stoplight.io/open-source/elements) make it SO EASY include full-fledged REPL-like functionality in your actual API docs, auto-generating samples using curl and a dozen-plus other methods and letting developers try the API out live from within the docs. I've standardized on using it for all my internal and external APIs, and OMG is it life-changing.

jlapoutre,

@kurtseifried I agree and I proves that Curl now is more or less the reference implementation example for HTTP methods. Translating from Curl to say Python requests or Unity C# methods is kind of intuitive. The exception is PHP which quite literally implements the low level C API from Curl, a strange and lazy choice IMHO

loke,
@loke@functional.cafe avatar

@kurtseifried you mean examples that start out with explaining how to install the Visual Studio extension isn't good?

alex_02,

@loke @kurtseifried oh god no

kurtseifried,

@loke I mean with API docs that have no examples for example seem to be really bad.

loke,
@loke@functional.cafe avatar

@kurtseifried I was actually agreeing with you. I have seen tutorials (or worse, trainings) where the exploration of the API's were completely through a UI.

kurtseifried,

@loke I guess at least we can automatically transcribe stuff now to get the text back. I utterly detest anything that is video first. Video as an addition/alternate, sure, but text uber alles!

jonor,

@loke @kurtseifried … from a link on Sourceforge.net

loke,
@loke@functional.cafe avatar

@kurtseifried you mean examples that start out with explaining how to install the Visual Studio extension isnt good?

  • All
  • Subscribed
  • Moderated
  • Favorites
  • random
  • DreamBathrooms
  • everett
  • InstantRegret
  • magazineikmin
  • thenastyranch
  • rosin
  • Durango
  • ethstaker
  • Youngstown
  • slotface
  • khanakhh
  • kavyap
  • ngwrru68w68
  • osvaldo12
  • JUstTest
  • tacticalgear
  • cubers
  • cisconetworking
  • anitta
  • provamag3
  • modclub
  • mdbf
  • GTA5RPClips
  • tester
  • megavids
  • normalnudes
  • Leos
  • lostlight
  • All magazines