Add getter that retrieves an array of routes for a Document.

Author: mattpolzin

Sources/OpenAPIKit/Document.swift

@@ -52,6 +52,31 @@ extension OpenAPI {
     }
 }
 
+extension OpenAPI.Document {
+    /// A `Route` is the combination of a path (where the route lives)
+    /// and a path item (the definition of the route).
+    public struct Route: Equatable {
+        public let path: OpenAPI.Path
+        public let pathItem: OpenAPI.PathItem
+
+        public init(
+            path: OpenAPI.Path,
+            pathItem: OpenAPI.PathItem
+        ) {
+            self.path = path
+            self.pathItem = pathItem
+        }
+    }
+
+    /// Get all routes for this document.
+    ///
+    /// - Returns: An Array of `Routes` with the path
+    ///     and the definition of the route.
+    public var routes: [Route] {
+        return paths.map { (path, pathItem) in .init(path: path, pathItem: pathItem) }
+    }
+}
+
 extension OpenAPI {
     /// If the security scheme is of type "oauth2" or "openIdConnect",
     /// then the value is a list of scope names required for the execution.

Tests/OpenAPIKitTests/DocumentTests.swift

@@ -41,6 +41,43 @@ final class DocumentTests: XCTestCase {
         )
     }
 
+    func test_getRoutes() {
+        let pi1 = OpenAPI.PathItem(
+            parameters: [],
+            get: .init(
+                tags: "hi",
+                parameters: [],
+                responses: [:]
+            )
+        )
+
+        let pi2 = OpenAPI.PathItem(
+            get: .init(
+                responses: [:]
+            )
+        )
+
+        let test = OpenAPI.Document(
+            info: .init(title: "hi", version: "1.0"),
+            servers: [
+                .init(url: URL(string: "https://google.com")!)
+            ],
+            paths: [
+                "/hi/there": pi1,
+                "/hi": pi2
+            ],
+            components: .init(schemas: ["hello": .string])
+        )
+
+        XCTAssertEqual(
+            test.routes,
+            [
+                .init(path: "/hi/there", pathItem: pi1),
+                .init(path: "/hi", pathItem: pi2)
+            ]
+        )
+    }
+
     func test_existingSecuritySchemeSuccess() {
         let docData =
 """