docs(readme): add types

yusukebe · Jan 13, 2024 · 57e1afa · 57e1afa
1 parent e8b7d88
commit 57e1afa
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -38,6 +38,31 @@ You might want to say _why Ramen?_ And, I will say. **_:ramen: is super deliciou
 https://ramen-api.dev
 ```
 
+## TypeScript Types
+
+```ts
+type Photo = {
+  name: string
+  url: string
+  width: number
+  height: number
+  authorId?: string
+  author?: Author
+}
+
+type Shop = {
+  id: string
+  name?: string
+  photos?: Photo[]
+}
+
+type Author = {
+  id: string
+  name: string
+  url: string
+}
+```
+
 ## REST API
 
 ![SS](https://user-images.githubusercontent.com/10682/163718724-1dbe9ea5-6dda-47ae-962b-1657e157c64a.png)