Hacker News new | ask | show | jobs
by ozten 1202 days ago
A terribly designed API with a complete and orderly OpenAPI 3.0.0 spec will get 5/5.

A well designed API with no OpenAPI support or 3.1.x spec support will get a poor design score.

I think user generated content might be the way to go for Design. Let people score and review the design quality.

4 comments

I would suggest renaming the Design category to Documentation. Design is subjective, so user generated content might be an option, but ultimately docs and examples as (non subjective) a measure are probably more useful to most developers.
Hey coauthor here.

Thanks for your feedback! APIRank is new, and we are here to improve it and make it useful to the community.

APIRank only considers APIs with an OpenAPI or Swagger specification. It supports any version of Swagger v2+ or OpenAPI v3+.

However, I agree in practice for people, the "design criterium" is not only the compliance to the spec ;)

Antoine

A well designed API with no OpenApi spec support will not show up on this list.
I agree with your point, yet we thought the data we gathered could be interesting, for instance we observe that ~60% of routes have human readable comments, but less than 10% have actual examples.