{
  "code": null,
  "collection": "architecture",
  "href": "https://banes-lab.com/ontology#architecture-uniform-interface",
  "id": "uniform-interface",
  "kind": "constraint",
  "layer": {
    "href": "https://banes-lab.com/ontology/schema#layer-contracts-core",
    "json": "https://banes-lab.com/json/records/layer/contracts-core",
    "label": "Contracts Core",
    "markdown": "https://banes-lab.com/records/layer/contracts-core.md",
    "ref": "layer:contracts-core"
  },
  "name": "Uniform Interface",
  "ref": "architecture:uniform-interface",
  "relations": [
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-consistent-semantics",
          "json": "https://banes-lab.com/json/records/lexicon/consistent-semantics",
          "label": "Consistent Semantics",
          "markdown": "https://banes-lab.com/records/lexicon/consistent-semantics.md",
          "ref": "lexicon:consistent-semantics"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-stable-contracts",
          "json": "https://banes-lab.com/json/records/lexicon/stable-contracts",
          "label": "Stable Contracts",
          "markdown": "https://banes-lab.com/records/lexicon/stable-contracts.md",
          "ref": "lexicon:stable-contracts"
        }
      ],
      "relation": "requires"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-principle-of-least-surprise",
          "json": "https://banes-lab.com/json/records/architecture/principle-of-least-surprise",
          "label": "Principle of Least Surprise",
          "markdown": "https://banes-lab.com/records/architecture/principle-of-least-surprise.md",
          "ref": "architecture:principle-of-least-surprise"
        }
      ],
      "relation": "reinforces"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-api-usability",
          "json": "https://banes-lab.com/json/records/lexicon/api-usability",
          "label": "API Usability",
          "markdown": "https://banes-lab.com/records/lexicon/api-usability.md",
          "ref": "lexicon:api-usability"
        }
      ],
      "relation": "enables"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-ad-hoc-endpoints",
          "json": "https://banes-lab.com/json/records/lexicon/ad-hoc-endpoints",
          "label": "Ad-Hoc Endpoints",
          "markdown": "https://banes-lab.com/records/lexicon/ad-hoc-endpoints.md",
          "ref": "lexicon:ad-hoc-endpoints"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-chatty-interface",
          "json": "https://banes-lab.com/json/records/architecture/chatty-interface",
          "label": "Chatty Interface",
          "markdown": "https://banes-lab.com/records/architecture/chatty-interface.md",
          "ref": "architecture:chatty-interface"
        }
      ],
      "relation": "conflicts-with"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-specialized-endpoints",
          "json": "https://banes-lab.com/json/records/lexicon/specialized-endpoints",
          "label": "Specialized Endpoints",
          "markdown": "https://banes-lab.com/records/lexicon/specialized-endpoints.md",
          "ref": "lexicon:specialized-endpoints"
        }
      ],
      "relation": "tensions-with"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/schema#tension-specialized-endpoints-uniform-interface",
          "json": "https://banes-lab.com/json/records/tension/specialized-endpoints-uniform-interface",
          "label": "Uniform Interface / Specialized Endpoints",
          "markdown": "https://banes-lab.com/records/tension/specialized-endpoints-uniform-interface.md",
          "ref": "tension:specialized-endpoints-uniform-interface"
        }
      ],
      "relation": "tensions"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-ambiguous-api",
          "json": "https://banes-lab.com/json/records/lexicon/ambiguous-api",
          "label": "Ambiguous API",
          "markdown": "https://banes-lab.com/records/lexicon/ambiguous-api.md",
          "ref": "lexicon:ambiguous-api"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-inconsistent-error-model",
          "json": "https://banes-lab.com/json/records/architecture/inconsistent-error-model",
          "label": "Inconsistent Error Model",
          "markdown": "https://banes-lab.com/records/architecture/inconsistent-error-model.md",
          "ref": "architecture:inconsistent-error-model"
        }
      ],
      "relation": "violated-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-standardize-the-interface",
          "json": "https://banes-lab.com/json/records/lexicon/standardize-the-interface",
          "label": "Standardize the Interface",
          "markdown": "https://banes-lab.com/records/lexicon/standardize-the-interface.md",
          "ref": "lexicon:standardize-the-interface"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-standard-error-contract",
          "json": "https://banes-lab.com/json/records/lexicon/standard-error-contract",
          "label": "Standard Error Contract",
          "markdown": "https://banes-lab.com/records/lexicon/standard-error-contract.md",
          "ref": "lexicon:standard-error-contract"
        }
      ],
      "relation": "refactored-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/schema#vocabulary-severity-recommended",
          "json": "https://banes-lab.com/json/records/vocabulary/severity-recommended",
          "label": "recommended",
          "markdown": "https://banes-lab.com/records/vocabulary/severity-recommended.md",
          "ref": "vocabulary:severity-recommended"
        }
      ],
      "relation": "severity"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-category-contracts-interfaces-compatibility",
          "json": "https://banes-lab.com/json/records/architecture-category/contracts-interfaces-compatibility",
          "label": "Contracts / Interfaces / Compatibility",
          "markdown": "https://banes-lab.com/records/architecture-category/contracts-interfaces-compatibility.md",
          "ref": "architecture-category:contracts-interfaces-compatibility"
        }
      ],
      "relation": "category"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-composite-pattern",
          "json": "https://banes-lab.com/json/records/architecture/composite-pattern",
          "label": "Composite Pattern",
          "markdown": "https://banes-lab.com/records/architecture/composite-pattern.md",
          "ref": "architecture:composite-pattern"
        }
      ],
      "relation": "reinforced-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-category-anti-patterns",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-anti-patterns",
          "label": "Anti-patterns",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-anti-patterns.md",
          "ref": "chapter:/ontology#architecture-category-anti-patterns"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-category-structural-patterns",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-structural-patterns",
          "label": "Structural Patterns",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-structural-patterns.md",
          "ref": "chapter:/ontology#architecture-category-structural-patterns"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-category-schema-canonical-data-semantics",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-schema-canonical-data-semantics",
          "label": "Schema / Canonical Data / Semantics",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-schema-canonical-data-semantics.md",
          "ref": "chapter:/ontology#architecture-category-schema-canonical-data-semantics"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-category-contracts-interfaces-compatibility",
          "json": "https://banes-lab.com/json/ontology/lexicon/lexicon-category-contracts-interfaces-compatibility",
          "label": "Contracts / Interfaces / Compatibility",
          "markdown": "https://banes-lab.com/ontology/lexicon/lexicon-category-contracts-interfaces-compatibility.md",
          "ref": "chapter:/ontology/lexicon#lexicon-category-contracts-interfaces-compatibility"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-category-core-vocabulary",
          "json": "https://banes-lab.com/json/ontology/lexicon/lexicon-category-core-vocabulary",
          "label": "Core Vocabulary",
          "markdown": "https://banes-lab.com/ontology/lexicon/lexicon-category-core-vocabulary.md",
          "ref": "chapter:/ontology/lexicon#lexicon-category-core-vocabulary"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-category-schema-canonical-data-semantics",
          "json": "https://banes-lab.com/json/ontology/lexicon/lexicon-category-schema-canonical-data-semantics",
          "label": "Schema / Canonical Data / Semantics",
          "markdown": "https://banes-lab.com/ontology/lexicon/lexicon-category-schema-canonical-data-semantics.md",
          "ref": "chapter:/ontology/lexicon#lexicon-category-schema-canonical-data-semantics"
        },
        {
          "href": "https://banes-lab.com/ontology/schema#the-vocabulary-severity",
          "json": "https://banes-lab.com/json/ontology/schema/the-vocabulary-severity",
          "label": "Severity levels",
          "markdown": "https://banes-lab.com/ontology/schema/the-vocabulary-severity.md",
          "ref": "chapter:/ontology/schema#the-vocabulary-severity"
        },
        {
          "href": "https://banes-lab.com/ontology/schema#the-resolutions",
          "json": "https://banes-lab.com/json/ontology/schema/the-resolutions",
          "label": "The resolutions",
          "markdown": "https://banes-lab.com/ontology/schema/the-resolutions.md",
          "ref": "chapter:/ontology/schema#the-resolutions"
        }
      ],
      "relation": "linked-from"
    }
  ],
  "summary": "A rule or precondition that every resource in an API uses the same verbs, response shapes and error format.",
  "siblings": {
    "next": {
      "href": "https://banes-lab.com/ontology#architecture-consumer-driven-contracts",
      "json": "https://banes-lab.com/json/records/architecture/consumer-driven-contracts",
      "label": "Consumer-Driven Contracts",
      "markdown": "https://banes-lab.com/records/architecture/consumer-driven-contracts.md",
      "ref": "architecture:consumer-driven-contracts"
    },
    "previous": {
      "href": "https://banes-lab.com/ontology#architecture-interoperability",
      "json": "https://banes-lab.com/json/records/architecture/interoperability",
      "label": "Interoperability",
      "markdown": "https://banes-lab.com/records/architecture/interoperability.md",
      "ref": "architecture:interoperability"
    }
  },
  "up": {
    "href": null,
    "json": "https://banes-lab.com/json/api/records/architecture",
    "label": "Architecture principles",
    "markdown": "https://banes-lab.com/api/records/architecture.md",
    "ref": "api:records/architecture"
  },
  "aliases": [],
  "exemplar": {
    "after": "resourceClient.post(\"/foos\", foo);\nresourceClient.post(\"/bars\", bar);\nresourceClient.delete(`/bazes/${baz.id}`);",
    "before": "fooApi.createFoo(foo);\nbarApi.post(\"/bar\", bar);\nbazApi.execute(\"DELETE_BAZ\", baz.id);",
    "lang": "ts",
    "medium": "code"
  },
  "formedBy": null,
  "scope": [
    "API",
    "resource boundary"
  ],
  "severity": "recommended"
}