DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
Refcards Trend Reports Events Over 2 million developers have joined DZone. Join Today! Thanks for visiting DZone today,
Edit Profile Manage Email Subscriptions Moderation Admin Console How to Post to DZone Article Submission Guidelines
View Profile
Sign Out
Refcards
Trend Reports
Events
Zones
Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
  1. DZone
  2. Data Engineering
  3. Databases
  4. What Questions Would You Ask Across 50,000 API Definitions?

What Questions Would You Ask Across 50,000 API Definitions?

Recently, somebody asked me, "If you could run SQL/GraphQL queries over nearly 50K API definitions, what would you ask?" This is my response.

Kin Lane user avatar by
Kin Lane
·
Apr. 17, 17 · Opinion
Like (3)
Save
Tweet
Share
5.47K Views

Join the DZone community and get the full member experience.

Join For Free

Mike Ralphson (@PermittedSoc) asked me the other day, If you could run SQL/GraphQL queries over nearly 50K API definitions, what would you ask? I told him I would respond via blog post, which is one way I help amplify the conversation I have with other API folks in the space. Mike is doing some important work when it comes to API discovery, something that needs amplification if we are going to move this conversation forward.

OK, so what would I ask about nearly 50K API definitions if I had the opportunity to ask? Here are some of my thoughts:

  • What are all the paths used? I'd like to see a list of all path folders, separated by the forward slash, minus any parameters.
  • What paths folders actually are words? I'd like to know how coherent API design patterns are and how many are actually words in a dictionary. 
  • What are all the tags applied? A listing of all tags applied to APIs with counts for each time it is used.
  • What are all the parameters? A listing of all the parameters applied to APIs with counts for each used.
  • What are all the definitions? A listing of all definitions used as part of API requests and responses with counts next to each.
  • How many don't have definitions? What percentage of the API definitions do not have definitions describing their responses?
  • What businesses are involved? A listing of all companies involved with API definitions from contact information to domain ownership.
  • What is "whois" information for each domain? Pull "whois" information for all the domains involved in API definitions.
  • Which definitions do not have path summary or description? Which definitions have omitted the description of the path?
  • What's the average length of path summary and descriptions? Of the definitions with a description or summary, what is the average length?
  • How many APIs provide a link to terms of service? Checking to see if a term of service is part of the definition.
  • How many APIs provide contact information for an API? Checking to see if contact information is part of the definition.
  • How many APIs describe their headers? Looking for specific headers described as part of each path definition.
  • How many APIs use the body as part of their request? Looking for heavy body use as part of the request surface area of an API.
  • How many APIs have a security definition? Which of the APIs has provided a definition for how an API is secured?
  • How many APIs do not use response codes? Which of the APIs do not provide response codes for their API responses?
  • Which API response HTTP status codes used? Provide a list of API response HTTP status codes used, with counts for each.

This is a starting list of what I'd like to ask of 50K API definitions. It is something I'd have to think and write about more to be able to come up with more creative questions. I recommend publishing them all to a Github repository and let people start asking questions via an interface. You might not be able to answer all of the questions, but it would be interesting to see what people want to know--I am sure you could develop a pretty interesting look at how folks see API discovery, and what they are looking for.

API discovery is one of the areas of the API lifecycle that is pretty deficient due to how people view their APIs and how they often have their blinders on regarding the wider API community. Most folks are thinking about their APIs and maybe a handful of other APIs they are familiar with but do not consider API usage across industries, or the entire space. We need more work like this to occur. We need more API definitions to be made available, as well as more dynamic ways for folks to discover, understand, and learn about APIs that already exist.

API

Published at DZone with permission of Kin Lane, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

Popular on DZone

  • How to Deploy Machine Learning Models on AWS Lambda Using Docker
  • PostgreSQL: Bulk Loading Data With Node.js and Sequelize
  • The New DevOps Performance Clusters
  • Silver Bullet or False Panacea? 3 Questions for Data Contracts

Comments

Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com
  • +1 (919) 678-0300

Let's be friends: