Building the Flask API for Story Generation

Welcome to this lesson on building a Flask API for our short story generation service. In previous lessons, we've laid the groundwork by creating components like the PromptManager, StoryManager, and StoryGeneratorService. Now, we'll bring these components together by building a Flask API that will serve as the backbone of our application. An API, or Application Programming Interface, allows different software components to communicate with each other. In our case, it will enable users to interact with our story generation service through HTTP requests.

Before we dive into building our API, let's quickly recall how to set up a Flask environment. If you're working on your own device, you can install Flask using the following command:

pip install Flask

However, if you're using the CodeSignal environment, Flask is already pre-installed, so you can focus on writing and testing your code without worrying about setup.

Let's start by creating a simple Flask application. This will serve as the foundation for our API.

First, import the Flask class from the flask module and create an instance of it:

from flask import Flask

app = Flask(__name__)

Here, app is an instance of the Flask class, which represents our web application. The __name__ argument helps Flask determine the root path of the application.

Next, let's define a basic route that will render the homepage:

@app.route('/')
def index():
    return "Welcome to the Short Story Generator!"

In this code snippet, @app.route('/') is a decorator that tells Flask to execute the index function when the root URL (/) is accessed. The function returns a simple welcome message.

Now, let's implement the API endpoints that will handle story generation and retrieval.

We'll start by creating a POST endpoint to generate stories. This endpoint will accept user input and return a generated story.

from flask import request

@app.route('/api/generate_story', methods=['POST'])
def generate_story():
    user_input = request.json.get('user_input')
    return story_generator_controller.generate_story(user_input)

• @app.route('/api/generate_story', methods=['POST']): This decorator defines a route for the /api/generate_story URL, specifying that it accepts POST requests.
• request.json.get('user_input'): This line extracts the user_input from the JSON payload of the request.
• story_generator_controller.generate_story(user_input): This function call generates a story based on the user input.

Next, we'll create a GET endpoint to retrieve all generated stories.

@app.route('/api/get_stories', methods=['GET'])
def get_stories():
    return story_generator_controller.get_stories()

• @app.route('/api/get_stories', methods=['GET']): This decorator defines a route for the /api/get_stories URL, specifying that it accepts GET requests.
• story_generator_controller.get_stories(): This function call retrieves all generated stories.