Ruby Programming Language and Popular API Gems

A profile of the Ruby programming language ecosystem from an API perspective: the language and its standard library HTTP surface (Net::HTTP), the rubygems.org package registry and its public v1/v2 REST API, Bundler, RBS type signatures, popular HTTP/REST client gems (Faraday, http.rb, HTTParty, Excon, Typhoeus, REST Client, HTTPClient), and the major Ruby frameworks used to build APIs (Rails API mode, Sinatra, Grape).

Ruby Programming Language and Popular API Gems publishes 9 APIs on the APIs.io network, including Activity API, API Keys API, Downloads API, and 6 more. Tagged areas include Programming Language, Ruby, HTTP, REST, and API Clients.

The Ruby Programming Language and Popular API Gems catalog on APIs.io includes 1 JSON-LD context and 2 Spectral governance rulesets.

Ruby Programming Language and Popular API Gems’ developer surface includes authentication, documentation, getting-started guide, release notes, engineering blog, and 17 more developer resources.

🌐 Visit website 📡 Source on GitHub

47.4/100 developing ▬ flat Agent 28/100 agent aware Full breakdown ↓
scored 2026-07-28 · rubric v0.6

AccessSelf serve

23 APIs 6 Features 5 Use Cases

Programming LanguageRubyHTTPRESTAPI ClientsFrameworksLibrariesPackage Registry

Kin Score

Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6

Composite quality — 47.4/100 · developing

Contract Quality 19.2 / 25

Developer Ergonomics 7.4 / 20

Commercial Clarity 0.0 / 20

Operational Transparency 6.2 / 13

Governance 8.3 / 12

Discoverability 6.5 / 10

Agent readiness — 28/100 · agent aware

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

MCP Server 0 / 12

Machine-Readable Auth 10 / 10

Idempotency 0 / 9

Stable Error Semantics 0 / 8

Request/Response Examples 0 / 7

Rate-Limit Signaling 0 / 7

Typed Event Surface 0 / 6

Agent Skills 0 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/ruby: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 23

Individual APIs this provider publishes, each with its own machine-readable definition.

Net::HTTP (Ruby Standard Library)

The HTTP client class shipped with the Ruby standard library. Provides class and instance methods for GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS, TRACE plus WebDAV methods (CO...

RubyGems.org Registry API v2

Version 2 of the rubygems.org registry API. Adds gem version detail endpoints with optional platform query parameter, returning richer metadata than v1.

Bundler

Dependency manager for Ruby. Reads a Gemfile, resolves and installs gems from rubygems.org or alternate sources, and writes Gemfile.lock for reproducible installs across environ...

RBS (Ruby Type Signatures)

A language for describing the structure of Ruby programs. Lets developers declare classes, modules, method signatures, instance variables and inheritance in separate .rbs files ...

Faraday

Simple but flexible HTTP client library with a common interface over many adapters (Net::HTTP, Typhoeus, Patron, Excon, HTTPClient, and others) and Rack-style middleware for req...

HTTParty

HTTP client gem that "makes consuming RESTful web services dead easy" via a class-level DSL. Wraps Net::HTTP with parsing, query handling, and authentication helpers.

http.rb

Fast Ruby HTTP client built on the llhttp parser with a chainable request-building API, streaming bodies, persistent connections, and fine-grained timeout control.

Excon

EXtended HTTP(S) CONnections library focused on performance, persistent connections, and predictable behavior. Used as an adapter under Faraday and inside Fog/cloud SDKs.

Typhoeus

Libcurl-based HTTP client built for running HTTP requests in parallel. Pairs well with Hydra for fan-out integrations against many APIs at once.

REST Client

Simple HTTP and REST client for Ruby inspired by Sinatra's microframework style. Provides class-level GET/POST/PUT/DELETE helpers.

HTTPClient

Long-standing Ruby HTTP client providing "the functionality of libwww-perl (LWP) in Ruby". Supports keep-alive, cookies, proxies, and SSL.

Ruby on Rails (API Mode)

Rails generated with the --api flag boots a slimmer middleware stack and an ApplicationController inheriting from ActionController::API (rather than ActionController::Base), mak...

Sinatra

"DSL for quickly creating web applications in Ruby with minimal effort." Widely used to stand up small HTTP APIs and microservices without the ceremony of a full-stack framework.

Grape

"Opinionated framework for creating REST-like APIs in Ruby." Provides a routing DSL with parameter validation, versioning, and content-negotiation helpers; runs standalone or mo...

Ruby Programming Language and Popular API Gems Activity API

The Activity API from Ruby Programming Language and Popular API Gems — 2 operation(s) for activity.

Ruby Programming Language and Popular API Gems API Keys API

The API Keys API from Ruby Programming Language and Popular API Gems — 1 operation(s) for api keys.

Ruby Programming Language and Popular API Gems Downloads API

The Downloads API from Ruby Programming Language and Popular API Gems — 2 operation(s) for downloads.

Ruby Programming Language and Popular API Gems Gems API

The Gems API from Ruby Programming Language and Popular API Gems — 4 operation(s) for gems.

Ruby Programming Language and Popular API Gems OIDC API

The OIDC API from Ruby Programming Language and Popular API Gems — 1 operation(s) for oidc.

Ruby Programming Language and Popular API Gems Owners API

The Owners API from Ruby Programming Language and Popular API Gems — 1 operation(s) for owners.

Ruby Programming Language and Popular API Gems Profiles API

The Profiles API from Ruby Programming Language and Popular API Gems — 1 operation(s) for profiles.

Ruby Programming Language and Popular API Gems Versions API

The Versions API from Ruby Programming Language and Popular API Gems — 3 operation(s) for versions.

Ruby Programming Language and Popular API Gems Webhooks API

The Webhooks API from Ruby Programming Language and Popular API Gems — 4 operation(s) for webhooks.

Scroll for all 23

Open Collections 1

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

RubyGems.org Registry API

OPEN COLLECTION

Features 6

Notable capabilities this provider offers.

Dynamic, Object-Oriented Language

Ruby is a dynamic, open-source programming language with a focus on simplicity and productivity, with everything-is-an-object semantics.

Standard Library HTTP Client

Net::HTTP ships in the standard library and covers GET/POST/PUT/ DELETE/HEAD/PATCH/OPTIONS/TRACE plus WebDAV verbs and TLS.

Public Package Registry API

rubygems.org exposes versioned v1 and v2 REST APIs over HTTPS for discovering, publishing, and managing gems with JSON or YAML responses.

Trusted Publishing via OIDC

/api/v1/oidc/ endpoints let CI providers exchange OIDC tokens for short-lived RubyGems API keys instead of long-lived secrets.

Type Signatures with RBS

RBS provides a separate-file type signature language so Ruby code can carry an explicit, machine-checkable contract for IDEs and type checkers.

API-First Rails

rails new --api generates a Rails app with a JSON-oriented middleware stack and ActionController::API as the base class.

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Ruby Context

20 classes · 17 properties

JSON-LD

Spectral Rules 2

Spectral governance rulesets for linting and validating these APIs.

Ruby Programming Language and Popular API Gems API Rules

5 rules · 4 warnings 1 info

SPECTRAL

Ruby Programming Language and Popular API Gems API Rules

7 rules · 5 errors 2 warnings

SPECTRAL

JSON Schema 4

Standalone JSON Schema definitions for this provider's data models.

Gem

20 properties

JSON SCHEMA

Owner

3 properties

JSON SCHEMA

Version

13 properties

JSON SCHEMA

WebHook

2 properties

JSON SCHEMA

JSON Structure 2

JSON Structure definitions describing this provider's data shapes.

Rubygems Registry Gem Structure

19 properties

JSON STRUCTURE

Rubygems Registry Version Structure

13 properties

JSON STRUCTURE

Examples 2

Example request and response payloads for these APIs.

Rubygems Registry Create Webhook Example

2 fields

EXAMPLE

Rubygems Registry Get Gem Example

20 fields

EXAMPLE

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Ruby Authentication

apiKey/http · 2 schemes

SECURITY

Ruby Domain Security

TLSv1.3 · DMARC

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Ruby Agentic Access

22 operations · 8 acting

AGENTIC

Use Cases 5

What developers build with this provider.

Consuming Third-Party HTTP APIs

Calling external REST APIs from Ruby scripts, jobs, and services using Net::HTTP, Faraday, http.rb, HTTParty, or Excon.

Building JSON APIs

Standing up REST/JSON APIs with Rails in --api mode, Sinatra, or Grape, optionally documented with OpenAPI tooling.

Publishing and Managing Gems

Releasing libraries to rubygems.org via the v1 publish endpoints and the gem and bundler CLIs, including trusted-publishing flows.

Mirroring or Caching a Private Gem Server

Running gemstash as a rubygems.org cache and private gem server inside an enterprise.

Static Analysis and IDE Support

Writing .rbs signatures so type checkers and IDEs can validate method shapes against the implementation.

Integrations 5

Pre-built integrations with other platforms and tools.

rubygems.org Registry

The default gem source for bundler and the gem CLI, accessible over HTTPS at https://rubygems.org and https://rubygems.org/api/v1.

GitHub Actions (setup-ruby)

ruby/setup-ruby installs prebuilt Ruby versions in CI for building, testing, and publishing gems.

OIDC Trusted Publishing

/api/v1/oidc/ exchanges short-lived CI OIDC tokens for scoped rubygems.org API keys, eliminating long-lived secrets.

Fastly CDN

rubygems.org serves gem downloads and the API surface through Fastly edge caching, tracked on status.rubygems.org.

HackerOne Vulnerability Disclosure

Ruby core security issues are reported through the official HackerOne program and the security@ruby-lang.org mailing list.

Solutions 3

Packaged solutions this provider offers.

Self-Hosted RubyGems with Gemstash

A caching proxy and private gem server for organizations that need air-gapped or controlled gem distribution.

Rails-Powered API Backends

Production JSON API backends built on Rails --api mode with Active Record, Active Job, and Action Cable as needed.

Sinatra Microservices

Lightweight HTTP services and API gateways built on Sinatra's minimal DSL.

Resources

Get Started 2

Portal, sign-up, and the first successful call

GettingStarted

GettingStarted

Registry

Registry

Documentation 1

Reference material describing how the API behaves

Documentation

Documentation

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess

AgenticAccess

Design & Contract 3

Pagination, idempotency, versioning, errors, and events

SpectralRules

SpectralRules

Vocabulary

Vocabulary

JSONLD

JSONLD

Build 4

SDKs, sample code, and the tooling you integrate with

GitHubOrganization

GitHubOrganization

GitHubOrganization

GitHubOrganization

GitHubOrganization

GitHubOrganization

SourceCode

SourceCode

Access & Security 3

Authentication, authorization, and security posture

DomainSecurity

DomainSecurity

Authentication

Authentication

Security

Security

Operate 3

Status, limits, changes, and where to get help

ReleaseNotes

ReleaseNotes

Community

Community

StatusPage

StatusPage

Commercial 1

Pricing, plans, and the legal terms of use

License

License

Company 3

The organization behind the API

Website

Website

Blog

Blog

Blog

Blog

Other 1

Properties that don't map to a standard resource type

Downloads

Downloads

Source (apis.yml)

aid: ruby
name: Ruby Programming Language and Popular API Gems
description: 'A profile of the Ruby programming language ecosystem from an API perspective: the language and its standard
  library HTTP surface (Net::HTTP), the rubygems.org package registry and its public v1/v2 REST API, Bundler, RBS type signatures,
  popular HTTP/REST client gems (Faraday, http.rb, HTTParty, Excon, Typhoeus, REST Client, HTTPClient), and the major Ruby
  frameworks used to build APIs (Rails API mode, Sinatra, Grape).'
type: Index
accessModel:
  pricing: unknown
  onboarding: self-serve
  trial: false
  try_now: false
  public: false
  label: Self-serve signup
  confidence: medium
  source:
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/ruby.png
tags:
- Programming Language
- Ruby
- HTTP
- REST
- API Clients
- Frameworks
- Libraries
- Package Registry
url: https://raw.githubusercontent.com/api-evangelist/ruby/refs/heads/main/apis.yml
created: '2026-05-23'
modified: '2026-05-23'
specificationVersion: '0.19'
apis:
- aid: ruby:net-http
  name: Net::HTTP (Ruby Standard Library)
  description: The HTTP client class shipped with the Ruby standard library. Provides class and instance methods for GET,
    POST, PUT, DELETE, HEAD, PATCH, OPTIONS, TRACE plus WebDAV methods (COPY, LOCK, MKCOL, MOVE, PROPFIND, PROPPATCH, UNLOCK),
    TLS, proxy support, and configurable timeouts. Backs many higher-level gems such as Faraday's default adapter.
  humanURL: https://docs.ruby-lang.org/en/master/Net/HTTP.html
  tags:
  - HTTP Client
  - Standard Library
  - Built-In
  properties:
  - type: Documentation
    url: https://docs.ruby-lang.org/en/master/Net/HTTP.html
  - type: GitHub
    url: https://github.com/ruby/net-http
- aid: ruby:rubygems-registry-api-v2
  name: RubyGems.org Registry API v2
  description: Version 2 of the rubygems.org registry API. Adds gem version detail endpoints with optional platform query
    parameter, returning richer metadata than v1.
  humanURL: https://guides.rubygems.org/rubygems-org-api-v2/
  baseURL: https://rubygems.org/api/v2
  tags:
  - Package Registry
  - REST
  - Public API
  properties:
  - type: Documentation
    url: https://guides.rubygems.org/rubygems-org-api-v2/
  - type: APIReference
    url: https://guides.rubygems.org/rubygems-org-api-v2/
- aid: ruby:bundler
  name: Bundler
  description: Dependency manager for Ruby. Reads a Gemfile, resolves and installs gems from rubygems.org or alternate sources,
    and writes Gemfile.lock for reproducible installs across environments. Ships as part of modern Ruby distributions.
  humanURL: https://bundler.io/
  tags:
  - Dependency Management
  - CLI
  - Package Manager
  properties:
  - type: Documentation
    url: https://bundler.io/docs.html
  - type: GitHub
    url: https://github.com/rubygems/rubygems
- aid: ruby:rbs
  name: RBS (Ruby Type Signatures)
  description: A language for describing the structure of Ruby programs. Lets developers declare classes, modules, method
    signatures, instance variables and inheritance in separate .rbs files so type checkers and IDE tooling can verify code
    against an explicit contract.
  humanURL: https://github.com/ruby/rbs
  tags:
  - Type System
  - Schema
  - Contracts
  properties:
  - type: GitHub
    url: https://github.com/ruby/rbs
  - type: Documentation
    url: https://github.com/ruby/rbs#readme
- aid: ruby:faraday
  name: Faraday
  description: Simple but flexible HTTP client library with a common interface over many adapters (Net::HTTP, Typhoeus, Patron,
    Excon, HTTPClient, and others) and Rack-style middleware for request/response processing.
  humanURL: https://lostisland.github.io/faraday/
  tags:
  - HTTP Client
  - Middleware
  properties:
  - type: Documentation
    url: https://lostisland.github.io/faraday/
  - type: GitHub
    url: https://github.com/lostisland/faraday
- aid: ruby:httparty
  name: HTTParty
  description: HTTP client gem that "makes consuming RESTful web services dead easy" via a class-level DSL. Wraps Net::HTTP
    with parsing, query handling, and authentication helpers.
  humanURL: https://github.com/jnunemaker/httparty
  tags:
  - HTTP Client
  - REST
  properties:
  - type: GitHub
    url: https://github.com/jnunemaker/httparty
- aid: ruby:http-rb
  name: http.rb
  description: Fast Ruby HTTP client built on the llhttp parser with a chainable request-building API, streaming bodies, persistent
    connections, and fine-grained timeout control.
  humanURL: https://github.com/httprb/http
  tags:
  - HTTP Client
  - Streaming
  properties:
  - type: GitHub
    url: https://github.com/httprb/http
- aid: ruby:excon
  name: Excon
  description: EXtended HTTP(S) CONnections library focused on performance, persistent connections, and predictable behavior.
    Used as an adapter under Faraday and inside Fog/cloud SDKs.
  humanURL: https://github.com/excon/excon
  tags:
  - HTTP Client
  properties:
  - type: GitHub
    url: https://github.com/excon/excon
- aid: ruby:typhoeus
  name: Typhoeus
  description: Libcurl-based HTTP client built for running HTTP requests in parallel. Pairs well with Hydra for fan-out integrations
    against many APIs at once.
  humanURL: https://github.com/typhoeus/typhoeus
  tags:
  - HTTP Client
  - Parallel
  properties:
  - type: GitHub
    url: https://github.com/typhoeus/typhoeus
- aid: ruby:rest-client
  name: REST Client
  description: Simple HTTP and REST client for Ruby inspired by Sinatra's microframework style. Provides class-level GET/POST/PUT/DELETE
    helpers.
  humanURL: https://github.com/rest-client/rest-client
  tags:
  - HTTP Client
  - REST
  properties:
  - type: GitHub
    url: https://github.com/rest-client/rest-client
- aid: ruby:httpclient
  name: HTTPClient
  description: Long-standing Ruby HTTP client providing "the functionality of libwww-perl (LWP) in Ruby". Supports keep-alive,
    cookies, proxies, and SSL.
  humanURL: https://github.com/nahi/httpclient
  tags:
  - HTTP Client
  properties:
  - type: GitHub
    url: https://github.com/nahi/httpclient
- aid: ruby:rails-api
  name: Ruby on Rails (API Mode)
  description: Rails generated with the --api flag boots a slimmer middleware stack and an ApplicationController inheriting
    from ActionController::API (rather than ActionController::Base), making Rails a first-class JSON API framework while keeping
    Active Record, routing, and generators.
  humanURL: https://guides.rubyonrails.org/api_app.html
  tags:
  - Web Framework
  - REST
  - JSON API
  properties:
  - type: Documentation
    url: https://guides.rubyonrails.org/api_app.html
  - type: GitHub
    url: https://github.com/rails/rails
  - type: Website
    url: https://rubyonrails.org/
- aid: ruby:sinatra
  name: Sinatra
  description: '"DSL for quickly creating web applications in Ruby with minimal effort." Widely used to stand up small HTTP
    APIs and microservices without the ceremony of a full-stack framework.'
  humanURL: https://sinatrarb.com/
  tags:
  - Web Framework
  - Microframework
  - DSL
  properties:
  - type: Documentation
    url: https://sinatrarb.com/documentation.html
  - type: GitHub
    url: https://github.com/sinatra/sinatra
- aid: ruby:grape
  name: Grape
  description: '"Opinionated framework for creating REST-like APIs in Ruby." Provides a routing DSL with parameter validation,
    versioning, and content-negotiation helpers; runs standalone or mounted in Rails.'
  humanURL: https://github.com/ruby-grape/grape
  tags:
  - Web Framework
  - REST
  - DSL
  properties:
  - type: GitHub
    url: https://github.com/ruby-grape/grape
  - type: Documentation
    url: https://github.com/ruby-grape/grape#readme
- aid: ruby:ruby-activity-api
  name: Ruby Programming Language and Popular API Gems Activity API
  description: The Activity API from Ruby Programming Language and Popular API Gems — 2 operation(s) for activity.
  humanURL: https://docs.ruby-lang.org/en/master/Net/HTTP.html
  baseURL: https://rubygems.org/api/v1
  tags:
  - Activity
  properties:
  - type: OpenAPI
    url: openapi/ruby-activity-api-openapi.yml
  - type: Documentation
    url: https://guides.rubygems.org/rubygems-org-api/
  - type: APIReference
    url: https://guides.rubygems.org/rubygems-org-api/
  - type: Authentication
    url: https://guides.rubygems.org/api-key-scopes/
  - type: GitHub
    url: https://github.com/rubygems/rubygems.org
  - type: SDKs
    url: https://github.com/rubygems/gems
  - type: JSONSchema
    url: json-schema/rubygems-registry-gem-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-version-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-owner-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-webhook-schema.json
  - type: JSONStructure
    url: json-structure/rubygems-registry-gem-structure.json
  - type: JSONStructure
    url: json-structure/rubygems-registry-version-structure.json
  - type: Examples
    url: examples/rubygems-registry-get-gem-example.json
  - type: Examples
    url: examples/rubygems-registry-list-versions-example.json
  - type: Examples
    url: examples/rubygems-registry-list-owners-example.json
  - type: Examples
    url: examples/rubygems-registry-search-example.json
  - type: Examples
    url: examples/rubygems-registry-create-webhook-example.json
- aid: ruby:ruby-api-keys-api
  name: Ruby Programming Language and Popular API Gems API Keys API
  description: The API Keys API from Ruby Programming Language and Popular API Gems — 1 operation(s) for api keys.
  humanURL: https://docs.ruby-lang.org/en/master/Net/HTTP.html
  baseURL: https://rubygems.org/api/v1
  tags:
  - API Keys
  properties:
  - type: OpenAPI
    url: openapi/ruby-api-keys-api-openapi.yml
  - type: Documentation
    url: https://guides.rubygems.org/rubygems-org-api/
  - type: APIReference
    url: https://guides.rubygems.org/rubygems-org-api/
  - type: Authentication
    url: https://guides.rubygems.org/api-key-scopes/
  - type: GitHub
    url: https://github.com/rubygems/rubygems.org
  - type: SDKs
    url: https://github.com/rubygems/gems
  - type: JSONSchema
    url: json-schema/rubygems-registry-gem-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-version-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-owner-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-webhook-schema.json
  - type: JSONStructure
    url: json-structure/rubygems-registry-gem-structure.json
  - type: JSONStructure
    url: json-structure/rubygems-registry-version-structure.json
  - type: Examples
    url: examples/rubygems-registry-get-gem-example.json
  - type: Examples
    url: examples/rubygems-registry-list-versions-example.json
  - type: Examples
    url: examples/rubygems-registry-list-owners-example.json
  - type: Examples
    url: examples/rubygems-registry-search-example.json
  - type: Examples
    url: examples/rubygems-registry-create-webhook-example.json
- aid: ruby:ruby-downloads-api
  name: Ruby Programming Language and Popular API Gems Downloads API
  description: The Downloads API from Ruby Programming Language and Popular API Gems — 2 operation(s) for downloads.
  humanURL: https://docs.ruby-lang.org/en/master/Net/HTTP.html
  baseURL: https://rubygems.org/api/v1
  tags:
  - Downloads
  properties:
  - type: OpenAPI
    url: openapi/ruby-downloads-api-openapi.yml
  - type: Documentation
    url: https://guides.rubygems.org/rubygems-org-api/
  - type: APIReference
    url: https://guides.rubygems.org/rubygems-org-api/
  - type: Authentication
    url: https://guides.rubygems.org/api-key-scopes/
  - type: GitHub
    url: https://github.com/rubygems/rubygems.org
  - type: SDKs
    url: https://github.com/rubygems/gems
  - type: JSONSchema
    url: json-schema/rubygems-registry-gem-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-version-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-owner-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-webhook-schema.json
  - type: JSONStructure
    url: json-structure/rubygems-registry-gem-structure.json
  - type: JSONStructure
    url: json-structure/rubygems-registry-version-structure.json
  - type: Examples
    url: examples/rubygems-registry-get-gem-example.json
  - type: Examples
    url: examples/rubygems-registry-list-versions-example.json
  - type: Examples
    url: examples/rubygems-registry-list-owners-example.json
  - type: Examples
    url: examples/rubygems-registry-search-example.json
  - type: Examples
    url: examples/rubygems-registry-create-webhook-example.json
- aid: ruby:ruby-gems-api
  name: Ruby Programming Language and Popular API Gems Gems API
  description: The Gems API from Ruby Programming Language and Popular API Gems — 4 operation(s) for gems.
  humanURL: https://docs.ruby-lang.org/en/master/Net/HTTP.html
  baseURL: https://rubygems.org/api/v1
  tags:
  - Gems
  properties:
  - type: OpenAPI
    url: openapi/ruby-gems-api-openapi.yml
  - type: Documentation
    url: https://guides.rubygems.org/rubygems-org-api/
  - type: APIReference
    url: https://guides.rubygems.org/rubygems-org-api/
  - type: Authentication
    url: https://guides.rubygems.org/api-key-scopes/
  - type: GitHub
    url: https://github.com/rubygems/rubygems.org
  - type: SDKs
    url: https://github.com/rubygems/gems
  - type: JSONSchema
    url: json-schema/rubygems-registry-gem-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-version-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-owner-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-webhook-schema.json
  - type: JSONStructure
    url: json-structure/rubygems-registry-gem-structure.json
  - type: JSONStructure
    url: json-structure/rubygems-registry-version-structure.json
  - type: Examples
    url: examples/rubygems-registry-get-gem-example.json
  - type: Examples
    url: examples/rubygems-registry-list-versions-example.json
  - type: Examples
    url: examples/rubygems-registry-list-owners-example.json
  - type: Examples
    url: examples/rubygems-registry-search-example.json
  - type: Examples
    url: examples/rubygems-registry-create-webhook-example.json
- aid: ruby:ruby-oidc-api
  name: Ruby Programming Language and Popular API Gems OIDC API
  description: The OIDC API from Ruby Programming Language and Popular API Gems — 1 operation(s) for oidc.
  humanURL: https://docs.ruby-lang.org/en/master/Net/HTTP.html
  baseURL: https://rubygems.org/api/v1
  tags:
  - OIDC
  properties:
  - type: OpenAPI
    url: openapi/ruby-oidc-api-openapi.yml
  - type: Documentation
    url: https://guides.rubygems.org/rubygems-org-api/
  - type: APIReference
    url: https://guides.rubygems.org/rubygems-org-api/
  - type: Authentication
    url: https://guides.rubygems.org/api-key-scopes/
  - type: GitHub
    url: https://github.com/rubygems/rubygems.org
  - type: SDKs
    url: https://github.com/rubygems/gems
  - type: JSONSchema
    url: json-schema/rubygems-registry-gem-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-version-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-owner-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-webhook-schema.json
  - type: JSONStructure
    url: json-structure/rubygems-registry-gem-structure.json
  - type: JSONStructure
    url: json-structure/rubygems-registry-version-structure.json
  - type: Examples
    url: examples/rubygems-registry-get-gem-example.json
  - type: Examples
    url: examples/rubygems-registry-list-versions-example.json
  - type: Examples
    url: examples/rubygems-registry-list-owners-example.json
  - type: Examples
    url: examples/rubygems-registry-search-example.json
  - type: Examples
    url: examples/rubygems-registry-create-webhook-example.json
- aid: ruby:ruby-owners-api
  name: Ruby Programming Language and Popular API Gems Owners API
  description: The Owners API from Ruby Programming Language and Popular API Gems — 1 operation(s) for owners.
  humanURL: https://docs.ruby-lang.org/en/master/Net/HTTP.html
  baseURL: https://rubygems.org/api/v1
  tags:
  - Owners
  properties:
  - type: OpenAPI
    url: openapi/ruby-owners-api-openapi.yml
  - type: Documentation
    url: https://guides.rubygems.org/rubygems-org-api/
  - type: APIReference
    url: https://guides.rubygems.org/rubygems-org-api/
  - type: Authentication
    url: https://guides.rubygems.org/api-key-scopes/
  - type: GitHub
    url: https://github.com/rubygems/rubygems.org
  - type: SDKs
    url: https://github.com/rubygems/gems
  - type: JSONSchema
    url: json-schema/rubygems-registry-gem-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-version-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-owner-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-webhook-schema.json
  - type: JSONStructure
    url: json-structure/rubygems-registry-gem-structure.json
  - type: JSONStructure
    url: json-structure/rubygems-registry-version-structure.json
  - type: Examples
    url: examples/rubygems-registry-get-gem-example.json
  - type: Examples
    url: examples/rubygems-registry-list-versions-example.json
  - type: Examples
    url: examples/rubygems-registry-list-owners-example.json
  - type: Examples
    url: examples/rubygems-registry-search-example.json
  - type: Examples
    url: examples/rubygems-registry-create-webhook-example.json
- aid: ruby:ruby-profiles-api
  name: Ruby Programming Language and Popular API Gems Profiles API
  description: The Profiles API from Ruby Programming Language and Popular API Gems — 1 operation(s) for profiles.
  humanURL: https://docs.ruby-lang.org/en/master/Net/HTTP.html
  baseURL: https://rubygems.org/api/v1
  tags:
  - Profiles
  properties:
  - type: OpenAPI
    url: openapi/ruby-profiles-api-openapi.yml
  - type: Documentation
    url: https://guides.rubygems.org/rubygems-org-api/
  - type: APIReference
    url: https://guides.rubygems.org/rubygems-org-api/
  - type: Authentication
    url: https://guides.rubygems.org/api-key-scopes/
  - type: GitHub
    url: https://github.com/rubygems/rubygems.org
  - type: SDKs
    url: https://github.com/rubygems/gems
  - type: JSONSchema
    url: json-schema/rubygems-registry-gem-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-version-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-owner-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-webhook-schema.json
  - type: JSONStructure
    url: json-structure/rubygems-registry-gem-structure.json
  - type: JSONStructure
    url: json-structure/rubygems-registry-version-structure.json
  - type: Examples
    url: examples/rubygems-registry-get-gem-example.json
  - type: Examples
    url: examples/rubygems-registry-list-versions-example.json
  - type: Examples
    url: examples/rubygems-registry-list-owners-example.json
  - type: Examples
    url: examples/rubygems-registry-search-example.json
  - type: Examples
    url: examples/rubygems-registry-create-webhook-example.json
- aid: ruby:ruby-versions-api
  name: Ruby Programming Language and Popular API Gems Versions API
  description: The Versions API from Ruby Programming Language and Popular API Gems — 3 operation(s) for versions.
  humanURL: https://docs.ruby-lang.org/en/master/Net/HTTP.html
  baseURL: https://rubygems.org/api/v1
  tags:
  - Versions
  properties:
  - type: OpenAPI
    url: openapi/ruby-versions-api-openapi.yml
  - type: Documentation
    url: https://guides.rubygems.org/rubygems-org-api/
  - type: APIReference
    url: https://guides.rubygems.org/rubygems-org-api/
  - type: Authentication
    url: https://guides.rubygems.org/api-key-scopes/
  - type: GitHub
    url: https://github.com/rubygems/rubygems.org
  - type: SDKs
    url: https://github.com/rubygems/gems
  - type: JSONSchema
    url: json-schema/rubygems-registry-gem-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-version-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-owner-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-webhook-schema.json
  - type: JSONStructure
    url: json-structure/rubygems-registry-gem-structure.json
  - type: JSONStructure
    url: json-structure/rubygems-registry-version-structure.json
  - type: Examples
    url: examples/rubygems-registry-get-gem-example.json
  - type: Examples
    url: examples/rubygems-registry-list-versions-example.json
  - type: Examples
    url: examples/rubygems-registry-list-owners-example.json
  - type: Examples
    url: examples/rubygems-registry-search-example.json
  - type: Examples
    url: examples/rubygems-registry-create-webhook-example.json
- aid: ruby:ruby-webhooks-api
  name: Ruby Programming Language and Popular API Gems Webhooks API
  description: The Webhooks API from Ruby Programming Language and Popular API Gems — 4 operation(s) for webhooks.
  humanURL: https://docs.ruby-lang.org/en/master/Net/HTTP.html
  baseURL: https://rubygems.org/api/v1
  tags:
  - Webhooks
  properties:
  - type: OpenAPI
    url: openapi/ruby-webhooks-api-openapi.yml
  - type: Documentation
    url: https://guides.rubygems.org/rubygems-org-api/
  - type: APIReference
    url: https://guides.rubygems.org/rubygems-org-api/
  - type: Authentication
    url: https://guides.rubygems.org/api-key-scopes/
  - type: GitHub
    url: https://github.com/rubygems/rubygems.org
  - type: SDKs
    url: https://github.com/rubygems/gems
  - type: JSONSchema
    url: json-schema/rubygems-registry-gem-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-version-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-owner-schema.json
  - type: JSONSchema
    url: json-schema/rubygems-registry-webhook-schema.json
  - type: JSONStructure
    url: json-structure/rubygems-registry-gem-structure.json
  - type: JSONStructure
    url: json-structure/rubygems-registry-version-structure.json
  - type: Examples
    url: examples/rubygems-registry-get-gem-example.json
  - type: Examples
    url: examples/rubygems-registry-list-versions-example.json
  - type: Examples
    url: examples/rubygems-registry-list-owners-example.json
  - type: Examples
    url: examples/rubygems-registry-search-example.json
  - type: Examples
    url: examples/rubygems-registry-create-webhook-example.json
common:
- type: AgenticAccess
  url: agentic-access/ruby-agentic-access.yml
- type: DomainSecurity
  url: security/ruby-domain-security.yml
- type: Authentication
  url: authentication/ruby-authentication.yml
- type: SpectralRules
  url: rules/rubygems-registry-rules.yml
- type: Vocabulary
  url: vocabulary/ruby-vocabulary.yml
- type: JSONLD
  url: json-ld/ruby-context.jsonld
- type: Website
  url: https://www.ruby-lang.org/
- type: Documentation
  url: https://docs.ruby-lang.org/en/
- type: GettingStarted
  url: https://www.ruby-lang.org/en/documentation/quickstart/
- type: Downloads
  url: https://www.ruby-lang.org/en/downloads/
- type: ReleaseNotes
  url: https://www.ruby-lang.org/en/news/
- type: Security
  url: https://www.ruby-lang.org/en/security/
- type: Community
  url: https://www.ruby-lang.org/en/community/
- type: Blog
  url: https://www.ruby-lang.org/en/news/
- type: GitHubOrganization
  url: https://github.com/ruby
- type: GitHubOrganization
  url: https://github.com/rubygems
- type: GitHubOrganization
  url: https://github.com/rails
- type: SourceCode
  url: https://github.com/ruby/ruby
- type: Registry
  url: https://rubygems.org/
- type: StatusPage
  url: https://status.rubygems.org/
- type: Blog
  url: https://blog.rubygems.org/
- type: License
  url: https://www.ruby-lang.org/en/about/license.txt
- type: Features
  data:
  - name: Dynamic, Object-Oriented Language
    description: Ruby is a dynamic, open-source programming language with a focus on simplicity and productivity, with everything-is-an-object
      semantics.
  - name: Standard Library HTTP Client
    description: Net::HTTP ships in the standard library and covers GET/POST/PUT/ DELETE/HEAD/PATCH/OPTIONS/TRACE plus WebDAV
      verbs and TLS.
  - name: Public Package Registry API
    description: rubygems.org exposes versioned v1 and v2 REST APIs over HTTPS for discovering, publishing, and managing gems
      with JSON or YAML responses.
  - name: Trusted Publishing via OIDC
    description: /api/v1/oidc/ endpoints let CI providers exchange OIDC tokens for short-lived RubyGems API keys instead of
      long-lived secrets.
  - name: Type Signatures with RBS
    description: RBS provides a separate-file type signature language so Ruby code can carry an explicit, machine-checkable
      contract for IDEs and type checkers.
  - name: API-First Rails
    description: rails new --api generates a Rails app with a JSON-oriented middleware stack and ActionController::API as
      the base class.
- type: UseCases
  data:
  - name: Consuming Third-Party HTTP APIs
    description: Calling external REST APIs from Ruby scripts, jobs, and services using Net::HTTP, Faraday, http.rb, HTTParty,
      or Excon.
  - name: Building JSON APIs
    description: Standing up REST/JSON APIs with Rails in --api mode, Sinatra, or Grape, optionally documented with OpenAPI
      tooling.
  - name: Publishing and Managing Gems
    description: Releasing libraries to rubygems.org via the v1 publish endpoints and the gem and bundler CLIs, including
      trusted-publishing flows.
  - name: Mirroring or Caching a Private Gem Server
    description: Running gemstash as a rubygems.org cache and private gem server inside an enterprise.
  - name: Static Analysis and IDE Support
    description: Writing .rbs signatures so type checkers and IDEs can validate method shapes against the implementation.
- type: Integrations
  data:
  - name: rubygems.org Registry
    description: The default gem source for bundler and the gem CLI, accessible over HTTPS at https://rubygems.org and https://rubygems.org/api/v1.
  - name: GitHub Actions (setup-ruby)
    description: ruby/setup-ruby installs prebuilt Ruby versions in CI for building, testing, and publishing gems.
  - name: OIDC Trusted Publishing
    description: /api/v1/oidc/ exchanges short-lived CI OIDC tokens for scoped rubygems.org API keys, eliminating long-lived
      secrets.
  - name: Fastly CDN
    description: rubygems.org serves gem downloads and the API surface through Fastly edge caching, tracked on status.rubygems.org.
  - name: HackerOne Vulnerability Disclosure
    description: Ruby core security issues are reported through the official HackerOne program and the security@ruby-lang.org
      mailing list.
- type: Solutions
  data:
  - name: Self-Hosted RubyGems with Gemstash
    description: A caching proxy and private gem server for organizations that need air-gapped or controlled gem distribution.
  - name: Rails-Powered API Backends
    description: Production JSON API backends built on Rails --api mode with Active Record, Active Job, and Action Cable as
      needed.
  - name: Sinatra Microservices
    description: Lightweight HTTP services and API gateways built on Sinatra's minimal DSL.
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com