How nasa/utm-apis works
Project Type and Purpose
• Type: Open-source collection of OpenAPI/Swagger specifications
• Purpose: Define and version the APIs (and common data models) used in NASA’s UTM research system. Users generate code (models, servers, clients) from these specs.
High-level Component Breakdown
• Git Repository
• Branches/tags: master (dev), RELEASE (sandbox snapshots)
• Shared Domain Specs (utm-domains)
• utm-domain-commons.yaml, geojson, metadata, performance-auth
• These define reusable data models
• API Spec Groups (each a separate “service”)
• fims-api
• fimsauthz-api
• nuss-operator-api
• oper-api
• public-safety-uss
• uss-api
• uss-discovery-api
• urep-api
• vehicle
• Tooling & External Services
• Swagger Editor (local or online)
• SwaggerHub (remote API repository & codegen)
• swagger-codegen CLI / JAR
• Code Generation Output
• Model-only libraries (Java Spring, etc.)
• Full server stubs or client SDKs
Relationships & Data Flows
• Shared Domain Specs → imported by each API’s swagger.yaml
• API Specs (swagger.yaml) → fed into codegen tool
• Codegen tool ↔ configuration JSON (library, java8, packages, validations)
• Codegen output → local ZIP / Maven artifact → integrated into service codebases
• Git branches/tags drive which spec versions are used for code generation (master vs RELEASE)
Architectural Patterns & Principles
• Specification-first design: All contracts live as YAML, not code
• Modularity: One folder per API; one folder for domains
• Reusability: Common data models factored into utm-domains
• Version control via Git branches/tags for release management
• Code generation automates stub and model creation to enforce consistency