Editing article

Title

Summary

Content

OpenAPI specification is well known with API Developers and one of the areas that I wanted to explore was to see how well Duet AI for Developers is able to generate an OpenAPI Specification and then use that to generate a starter application.<h3>Pre-requisites</h3>We will assume that you have the following in place:<ul><li>A Google Cloud Project with billing enabled</li><li>Duet AI enabled for your Cloud Project</li></ul>In case you are looking for setting up Duet AI for your Google Cloud project, check out the steps over <a href="https://cloud.google.com/duet-ai/docs/discover/set-up-duet-ai">here</a>. The steps help you enable Duet AI in your Google Cloud Project and also setup the Cloud Shell IDE for working with Duet AI.<h3>My setup</h3>I am using Google Cloud Shell IDE and sending across my prompts to Duet AI via the Chat Interface available in the IDE.<figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*eSodnBGqk0Ojn5FyE4SnnA.png" /></figure><h3>Generate the OpenAPI Specification</h3>We will keep things simple here. We will work with a fictitious application that manages a list of books. Each book will have a list of attributes that we will specify and we will keep things focused on a few retrieval operations across books only.We askDuet AI to generate an OpenAPI Specification via the prompt given below:<blockquote>I am designing an API for searching a library of books. Each book has the following attributes: id, title, a list of categories, a list of authors, year published and a brief summary. Please generate an OpenAPI Specification that allows one to search for the following operations:</blockquote><blockquote>1. All books</blockquote><blockquote>2. A single book by id</blockquote><blockquote>3. Given a book id, find its categories</blockquote><blockquote>4. Given a book id, find its authors</blockquote>Duet AI came back with the following OpenAPI Specification<pre>swagger: &quot;2.0&quot; info: title: &quot;Book Search API&quot; description: &quot;This API allows you to search for books in a library.&quot; version: &quot;1.0.0&quot; host: &quot;bookshelf.googleapis.com&quot; schemes: - &quot;https&quot; paths: /books: get: summary: &quot;Get all books&quot; operationId: &quot;getAllBooks&quot; responses: &quot;200&quot;: description: &quot;A list of all books&quot; schema: type: &quot;array&quot; items: type: &quot;object&quot; properties: id: type: &quot;integer&quot; format: &quot;int64&quot; title: type: &quot;string&quot; categories: type: &quot;array&quot; items: type: &quot;string&quot; authors: type: &quot;array&quot; items: type: &quot;string&quot; yearPublished: type: &quot;integer&quot; format: &quot;int32&quot; summary: type: &quot;string&quot; /books/{id}: get: summary: &quot;Get a single book by id&quot; operationId: &quot;getBookById&quot; parameters: - name: &quot;id&quot; in: &quot;path&quot; required: true type: &quot;integer&quot; format: &quot;int64&quot; responses: &quot;200&quot;: description: &quot;The book with the given id&quot; schema: type: &quot;object&quot; properties: id: type: &quot;integer&quot; format: &quot;int64&quot; title: type: &quot;string&quot; categories: type: &quot;array&quot; items: type: &quot;string&quot; authors: type: &quot;array&quot; items: type: &quot;string&quot; yearPublished: type: &quot;integer&quot; format: &quot;int32&quot; summary: type: &quot;string&quot; /books/{id}/categories: get: summary: &quot;Get the categories for a book by id&quot; operationId: &quot;getCategoriesForBookById&quot; parameters: - name: &quot;id&quot; in: &quot;path&quot; required: true type: &quot;integer&quot; format: &quot;int64&quot; responses: &quot;200&quot;: description: &quot;The categories for the book with the given id&quot; schema: type: &quot;array&quot; items: type: &quot;string&quot; /books/{id}/authors: get: summary: &quot;Get the authors for a book by id&quot; operationId: &quot;getAuthorsForBookById&quot; parameters: - name: &quot;id&quot; in: &quot;path&quot; required: true type: &quot;integer&quot; format: &quot;int64&quot; responses: &quot;200&quot;: description: &quot;The authors for the book with the given id&quot; schema: type: &quot;array&quot; items: type: &quot;string&quot;</pre>It could have done better by defining the book schema. In fact, that is what I ask next via the following prompt:<blockquote>Please update the above specification to use a book schema.</blockquote>It comes back with the following:<pre>swagger: &quot;2.0&quot; info: title: &quot;Book Search API&quot; description: &quot;This API allows you to search for books in a library.&quot; version: &quot;1.0.0&quot; host: &quot;bookshelf.googleapis.com&quot; schemes: - &quot;https&quot; paths: /books: get: summary: &quot;Get all books&quot; operationId: &quot;getAllBooks&quot; responses: &quot;200&quot;: description: &quot;A list of all books&quot; schema: type: &quot;array&quot; items: $ref: &quot;#/definitions/Book&quot; /books/{id}: get: summary: &quot;Get a single book by id&quot; operationId: &quot;getBookById&quot; parameters: - name: &quot;id&quot; in: &quot;path&quot; required: true type: &quot;integer&quot; format: &quot;int64&quot; responses: &quot;200&quot;: description: &quot;The book with the given id&quot; schema: $ref: &quot;#/definitions/Book&quot; /books/{id}/categories: get: summary: &quot;Get the categories for a book by id&quot; operationId: &quot;getCategoriesForBookById&quot; parameters: - name: &quot;id&quot; in: &quot;path&quot; required: true type: &quot;integer&quot; format: &quot;int64&quot; responses: &quot;200&quot;: description: &quot;The categories for the book with the given id&quot; schema: type: &quot;array&quot; items: type: &quot;string&quot; /books/{id}/authors: get: summary: &quot;Get the authors for a book by id&quot; operationId: &quot;getAuthorsForBookById&quot; parameters: - name: &quot;id&quot; in: &quot;path&quot; required: true type: &quot;integer&quot; format: &quot;int64&quot; responses: &quot;200&quot;: description: &quot;The authors for the book with the given id&quot; schema: type: &quot;array&quot; items: type: &quot;string&quot; definitions: Book: type: &quot;object&quot; properties: id: type: &quot;integer&quot; format: &quot;int64&quot; title: type: &quot;string&quot; categories: type: &quot;array&quot; items: type: &quot;string&quot; authors: type: &quot;array&quot; items: type: &quot;string&quot; yearPublished: type: &quot;integer&quot; format: &quot;int32&quot; summary: type: &quot;string&quot;</pre><h3>Generate the starter app</h3>Now that the OpenAPI Specification has been generated, it would be good to get a starter application template for the API implementation, based on the specification and in a language/framework of your choice. Let’s ask Duet AI for help.I save the specification YAML in a file and then give the following prompt:<blockquote>Based on the above OpenAPI spec, can you generate a Python Flask App that uses only the Flask framework and will work with a local in memory list of books.</blockquote>Duet AI responded with the following:<pre>from flask import Flask, jsonify, request app = Flask(__name__) books = [ { &quot;id&quot;: 1, &quot;title&quot;: &quot;The Catcher in the Rye&quot;, &quot;categories&quot;: [&quot;Fiction&quot;, &quot;Coming of age&quot;], &quot;authors&quot;: [&quot;J.D. Salinger&quot;], &quot;yearPublished&quot;: 1951, &quot;summary&quot;: &quot;The Catcher in the Rye is a 1951 novel by J. D. Salinger. Originally published for adults, it has since become popular with adolescent readers for its themes of teenage angst and alienation. The novel has been translated widely. Around one million copies are sold each year with total sales of more than 65 million books.&quot; }, { &quot;id&quot;: 2, &quot;title&quot;: &quot;To Kill a Mockingbird&quot;, &quot;categories&quot;: [&quot;Fiction&quot;, &quot;Southern Gothic&quot;], &quot;authors&quot;: [&quot;Harper Lee&quot;], &quot;yearPublished&quot;: 1960, &quot;summary&quot;: &quot;To Kill a Mockingbird is a novel by American author Harper Lee. It was published in 1960 and was instantly successful. The plot and characters are loosely based on Lee&#39;s observations of her family and neighbors, as well as on an event that occurred near her hometown in 1936, when she was 10 years old.&quot; }, { &quot;id&quot;: 3, &quot;title&quot;: &quot;The Great Gatsby&quot;, &quot;categories&quot;: [&quot;Fiction&quot;, &quot;American literature&quot;], &quot;authors&quot;: [&quot;F. Scott Fitzgerald&quot;], &quot;yearPublished&quot;: 1925, &quot;summary&quot;: &quot;The Great Gatsby is a 1925 novel written by American author F. Scott Fitzgerald that follows a cast of characters living in the fictional town of West Egg on prosperous Long Island in the summer of 1922.&quot; } ] @app.route(&quot;/&quot;) def index(): return jsonify(books) @app.route(&quot;/books/&lt;int:id&gt;&quot;, methods=[&quot;GET&quot;]) def get_book(id): book = [book for book in books if book[&quot;id&quot;] == id] if book: return jsonify(book[0]) else: return jsonify({&quot;message&quot;: &quot;Book not found&quot;}), 404 @app.route(&quot;/books/&lt;int:id&gt;/categories&quot;, methods=[&quot;GET&quot;]) def get_categories_for_book(id): book = [book for book in books if book[&quot;id&quot;] == id] if book: return jsonify(book[0][&quot;categories&quot;]) else: return jsonify({&quot;message&quot;: &quot;Book not found&quot;}), 404 @app.route(&quot;/books/&lt;int:id&gt;/authors&quot;, methods=[&quot;GET&quot;]) def get_authors_for_book(id): book = [book for book in books if book[&quot;id&quot;] == id] if book: return jsonify(book[0][&quot;authors&quot;]) else: return jsonify({&quot;message&quot;: &quot;Book not found&quot;}), 404 if __name__ == &quot;__main__&quot;: app.run()</pre>The response from Duet AI also included some information on the endpoints as shown below:<figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*E2JLovrlAyHmriEIlUJ83w.png" /></figure>and instructions on how to run the application.This is good stuff and helps me to get up and running with minutes and I have a basic Python Flask implementation for my API.<img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=15d92e408bf9" width="1" height="1" alt=""><hr><a href="https://medium.com/google-cloud/using-duet-ai-to-generate-a-starter-app-from-an-openapi-specification-15d92e408bf9">Using Duet AI to generate a Starter App from an OpenAPI Specification</a> was originally published in <a href="https://medium.com/google-cloud">Google Cloud - Community</a> on Medium, where people are continuing the conversation by highlighting and responding to this story.

Author

Link

Published date

Image url

Feed url

Guid

Hidden blurb

--- !ruby/object:Feedjira::Parser::RSSEntry
title: Using Duet AI to generate a Starter App from an OpenAPI Specification
url: https://medium.com/google-cloud/using-duet-ai-to-generate-a-starter-app-from-an-openapi-specification-15d92e408bf9?source=rss-802a4d428d95------2
author: Romin Irani
categories:
- duet-ai
- gemini
- open-api
- gcp-app-dev
- google-cloud-platform
published: 2024-03-01 01:54:02.000000000 Z
entry_id: !ruby/object:Feedjira::Parser::GloballyUniqueIdentifier
 is_perma_link: 'false'
 guid: https://medium.com/p/15d92e408bf9
carlessian_info:
 news_filer_version: 2
 newspaper: Romin Irani - Medium
 macro_region: Blogs
rss_fields:
- title
- url
- author
- categories
- published
- entry_id
- content
content: 'OpenAPI specification is well known with API Developers and one of the
 areas that I wanted to explore was to see how well Duet AI for Developers is able
 to generate an OpenAPI Specification and then use that to generate a starter application.<h3>Pre-requisites</h3>We
 will assume that you have the following in place:<ul><li>A Google Cloud Project
 with billing enabled</li><li>Duet AI enabled for your Cloud Project</li></ul>In
 case you are looking for setting up Duet AI for your Google Cloud project, check
 out the steps over <a href="https://cloud.google.com/duet-ai/docs/discover/set-up-duet-ai">here</a>.
 The steps help you enable Duet AI in your Google Cloud Project and also setup the
 Cloud Shell IDE for working with Duet AI.<h3>My setup</h3>I am using Google
 Cloud Shell IDE and sending across my prompts to Duet AI via the Chat Interface
 available in the IDE.<figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*eSodnBGqk0Ojn5FyE4SnnA.png"
 /></figure><h3>Generate the OpenAPI Specification</h3>We will keep things simple
 here. We will work with a fictitious application that manages a list of books. Each
 book will have a list of attributes that we will specify and we will keep things
 focused on a few retrieval operations across books only.We askDuet AI to
 generate an OpenAPI Specification via the prompt given below:<blockquote>I am
 designing an API for searching a library of books. Each book has the following attributes:
 id, title, a list of categories, a list of authors, year published and a brief summary.
 Please generate an OpenAPI Specification that allows one to search for the following
 operations:</blockquote><blockquote>1. All books</blockquote><blockquote>2. A single
 book by id</blockquote><blockquote>3. Given a book id, find its categories</blockquote><blockquote>4.
 Given a book id, find its authors</blockquote>Duet AI came back with the following
 OpenAPI Specification<pre>swagger: &quot;2.0&quot; info: title: &quot;Book
 Search API&quot; description: &quot;This API allows you to search for books
 in a library.&quot; version: &quot;1.0.0&quot; host: &quot;bookshelf.googleapis.com&quot; schemes: -
 &quot;https&quot; paths: /books: get: summary: &quot;Get
 all books&quot; operationId: &quot;getAllBooks&quot; responses: &quot;200&quot;: description:
 &quot;A list of all books&quot; schema: type: &quot;array&quot; items: type:
 &quot;object&quot; properties: id: type:
 &quot;integer&quot; format: &quot;int64&quot; title: type:
 &quot;string&quot; categories: type: &quot;array&quot; items: type:
 &quot;string&quot; authors: type: &quot;array&quot; items: type:
 &quot;string&quot; yearPublished: type:
 &quot;integer&quot; format: &quot;int32&quot; summary: type:
 &quot;string&quot; /books/{id}: get: summary: &quot;Get a single
 book by id&quot; operationId: &quot;getBookById&quot; parameters: -
 name: &quot;id&quot; in: &quot;path&quot; required: true type:
 &quot;integer&quot; format: &quot;int64&quot; responses: &quot;200&quot;: description:
 &quot;The book with the given id&quot; schema: type:
 &quot;object&quot; properties: id: type:
 &quot;integer&quot; format: &quot;int64&quot; title: type:
 &quot;string&quot; categories: type: &quot;array&quot; items: type:
 &quot;string&quot; authors: type: &quot;array&quot; items: type:
 &quot;string&quot; yearPublished: type: &quot;integer&quot; format:
 &quot;int32&quot; summary: type: &quot;string&quot; /books/{id}/categories: get: summary:
 &quot;Get the categories for a book by id&quot; operationId: &quot;getCategoriesForBookById&quot; parameters: -
 name: &quot;id&quot; in: &quot;path&quot; required: true type:
 &quot;integer&quot; format: &quot;int64&quot; responses: &quot;200&quot;: description:
 &quot;The categories for the book with the given id&quot; schema: type:
 &quot;array&quot; items: type: &quot;string&quot; /books/{id}/authors: get: summary:
 &quot;Get the authors for a book by id&quot; operationId: &quot;getAuthorsForBookById&quot; parameters: -
 name: &quot;id&quot; in: &quot;path&quot; required: true type:
 &quot;integer&quot; format: &quot;int64&quot; responses: &quot;200&quot;: description:
 &quot;The authors for the book with the given id&quot; schema: type:
 &quot;array&quot; items: type: &quot;string&quot;</pre>It
 could have done better by defining the book schema. In fact, that is what I ask
 next via the following prompt:<blockquote>Please update the above specification
 to use a book schema.</blockquote>It comes back with the following:<pre>swagger:
 &quot;2.0&quot; info: title: &quot;Book Search API&quot; description:
 &quot;This API allows you to search for books in a library.&quot; version:
 &quot;1.0.0&quot; host: &quot;bookshelf.googleapis.com&quot; schemes: -
 &quot;https&quot; paths: /books: get: summary: &quot;Get
 all books&quot; operationId: &quot;getAllBooks&quot; responses: &quot;200&quot;: description:
 &quot;A list of all books&quot; schema: type: &quot;array&quot; items: $ref:
 &quot;#/definitions/Book&quot; /books/{id}: get: summary: &quot;Get
 a single book by id&quot; operationId: &quot;getBookById&quot; parameters: -
 name: &quot;id&quot; in: &quot;path&quot; required: true type:
 &quot;integer&quot; format: &quot;int64&quot; responses: &quot;200&quot;: description:
 &quot;The book with the given id&quot; schema: $ref:
 &quot;#/definitions/Book&quot; /books/{id}/categories: get: summary:
 &quot;Get the categories for a book by id&quot; operationId: &quot;getCategoriesForBookById&quot; parameters: -
 name: &quot;id&quot; in: &quot;path&quot; required: true type:
 &quot;integer&quot; format: &quot;int64&quot; responses: &quot;200&quot;: description:
 &quot;The categories for the book with the given id&quot; schema: type:
 &quot;array&quot; items: type: &quot;string&quot; /books/{id}/authors: get: summary:
 &quot;Get the authors for a book by id&quot; operationId: &quot;getAuthorsForBookById&quot; parameters: -
 name: &quot;id&quot; in: &quot;path&quot; required: true type:
 &quot;integer&quot; format: &quot;int64&quot; responses: &quot;200&quot;: description:
 &quot;The authors for the book with the given id&quot; schema: type:
 &quot;array&quot; items: type: &quot;string&quot; definitions: Book: type:
 &quot;object&quot; properties: id: type: &quot;integer&quot; format:
 &quot;int64&quot; title: type: &quot;string&quot; categories: type:
 &quot;array&quot; items: type: &quot;string&quot; authors: type:
 &quot;array&quot; items: type: &quot;string&quot; yearPublished: type:
 &quot;integer&quot; format: &quot;int32&quot; summary: type:
 &quot;string&quot;</pre><h3>Generate the starter app</h3>Now that the OpenAPI
 Specification has been generated, it would be good to get a starter application
 template for the API implementation, based on the specification and in a language/framework
 of your choice. Let’s ask Duet AI for help.I save the specification YAML
 in a file and then give the following prompt:<blockquote>Based on the above
 OpenAPI spec, can you generate a Python Flask App that uses only the Flask framework
 and will work with a local in memory list of books.</blockquote>Duet AI responded
 with the following:<pre>from flask import Flask, jsonify, request app
 = Flask(__name__) books = [ { &quot;id&quot;: 1, &quot;title&quot;:
 &quot;The Catcher in the Rye&quot;, &quot;categories&quot;: [&quot;Fiction&quot;,
 &quot;Coming of age&quot;], &quot;authors&quot;: [&quot;J.D. Salinger&quot;], &quot;yearPublished&quot;:
 1951, &quot;summary&quot;: &quot;The Catcher in the Rye is a 1951 novel
 by J. D. Salinger. Originally published for adults, it has since become popular
 with adolescent readers for its themes of teenage angst and alienation. The novel
 has been translated widely. Around one million copies are sold each year with total
 sales of more than 65 million books.&quot; }, { &quot;id&quot;:
 2, &quot;title&quot;: &quot;To Kill a Mockingbird&quot;, &quot;categories&quot;:
 [&quot;Fiction&quot;, &quot;Southern Gothic&quot;], &quot;authors&quot;:
 [&quot;Harper Lee&quot;], &quot;yearPublished&quot;: 1960, &quot;summary&quot;:
 &quot;To Kill a Mockingbird is a novel by American author Harper Lee. It was published
 in 1960 and was instantly successful. The plot and characters are loosely based
 on Lee&#39;s observations of her family and neighbors, as well as on an event that
 occurred near her hometown in 1936, when she was 10 years old.&quot; }, { &quot;id&quot;:
 3, &quot;title&quot;: &quot;The Great Gatsby&quot;, &quot;categories&quot;:
 [&quot;Fiction&quot;, &quot;American literature&quot;], &quot;authors&quot;:
 [&quot;F. Scott Fitzgerald&quot;], &quot;yearPublished&quot;: 1925, &quot;summary&quot;:
 &quot;The Great Gatsby is a 1925 novel written by American author F. Scott Fitzgerald
 that follows a cast of characters living in the fictional town of West Egg on prosperous
 Long Island in the summer of 1922.&quot; } ] @app.route(&quot;/&quot;) def
 index(): return jsonify(books) @app.route(&quot;/books/&lt;int:id&gt;&quot;,
 methods=[&quot;GET&quot;]) def get_book(id): book = [book for book in
 books if book[&quot;id&quot;] == id] if book: return jsonify(book[0]) else: return
 jsonify({&quot;message&quot;: &quot;Book not found&quot;}), 404 @app.route(&quot;/books/&lt;int:id&gt;/categories&quot;,
 methods=[&quot;GET&quot;]) def get_categories_for_book(id): book = [book
 for book in books if book[&quot;id&quot;] == id] if book: return
 jsonify(book[0][&quot;categories&quot;]) else: return jsonify({&quot;message&quot;:
 &quot;Book not found&quot;}), 404 @app.route(&quot;/books/&lt;int:id&gt;/authors&quot;,
 methods=[&quot;GET&quot;]) def get_authors_for_book(id): book = [book
 for book in books if book[&quot;id&quot;] == id] if book: return
 jsonify(book[0][&quot;authors&quot;]) else: return jsonify({&quot;message&quot;:
 &quot;Book not found&quot;}), 404 if __name__ == &quot;__main__&quot;: app.run()</pre>The
 response from Duet AI also included some information on the endpoints as shown below:<figure><img
 alt="" src="https://cdn-images-1.medium.com/max/1024/1*E2JLovrlAyHmriEIlUJ83w.png"
 /></figure>and instructions on how to run the application.This is good
 stuff and helps me to get up and running with minutes and I have a basic Python
 Flask implementation for my API.<img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=15d92e408bf9"
 width="1" height="1" alt=""><hr><a href="https://medium.com/google-cloud/using-duet-ai-to-generate-a-starter-app-from-an-openapi-specification-15d92e408bf9">Using
 Duet AI to generate a Starter App from an OpenAPI Specification</a> was originally
 published in <a href="https://medium.com/google-cloud">Google Cloud - Community</a>
 on Medium, where people are continuing the conversation by highlighting and responding
 to this story.'

Language

Active

Ricc internal notes

Ricc source

Show this article Back to articles