开源项目 `appengine-endpoints-helloendpoints-python` 安装与使用教程

开源项目 appengine-endpoints-helloendpoints-python 安装与使用教程

appengine-endpoints-helloendpoints-python项目地址:https://gitcode.com/gh_mirrors/ap/appengine-endpoints-helloendpoints-python

1. 项目的目录结构及介绍

appengine-endpoints-helloendpoints-python/
├── static/
├── templates/
├── .gitignore
├── CONTRIB.md
├── LICENSE
├── README.md
├── app.yaml
├── helloworld_api.py
└── index.html

目录结构介绍

• static/: 存放静态文件，如CSS、JavaScript等。
• templates/: 存放HTML模板文件。
• .gitignore: Git忽略文件配置。
• CONTRIB.md: 贡献指南。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• app.yaml: 项目的配置文件。
• helloworld_api.py: 项目的启动文件，包含API定义。
• index.html: 项目的默认HTML文件。

2. 项目的启动文件介绍

helloworld_api.py

helloworld_api.py 是项目的启动文件，主要负责定义和实现Google Cloud Endpoints的API。以下是文件的主要内容：

import endpoints
from protorpc import message_types
from protorpc import messages
from protorpc import remote

package = 'Hello'

class Greeting(messages.Message):
    """Greeting that stores a message."""
    message = messages.StringField(1)

class GreetingCollection(messages.Message):
    """Collection of Greetings."""
    items = messages.MessageField(Greeting, 1, repeated=True)

STORED_GREETINGS = GreetingCollection(items=[
    Greeting(message='hello world!'),
    Greeting(message='goodbye world!'),
])

@endpoints.api(name='helloworld', version='v1')
class HelloWorldApi(remote.Service):
    """Helloworld API v1."""

    @endpoints.method(message_types.VoidMessage, GreetingCollection,
                      path='hellogreeting', http_method='GET',
                      name='greetings.list')
    def greetings_list(self, unused_request):
        return STORED_GREETINGS

    @endpoints.method(Greeting, Greeting,
                      path='hellogreeting', http_method='POST',
                      name='greetings.insert')
    def greetings_insert(self, greeting):
        STORED_GREETINGS.items.append(greeting)
        return greeting

APPLICATION = endpoints.api_server([HelloWorldApi])

文件功能介绍

• Greeting 类: 定义了一个消息类，用于存储问候语。
• GreetingCollection 类: 定义了一个消息集合类，用于存储多个问候语。
• HelloWorldApi 类: 定义了一个API服务类，包含两个方法：greetings_list 和 greetings_insert。
  • greetings_list: 返回存储的问候语列表。
  • greetings_insert: 插入新的问候语。
• APPLICATION: 启动API服务器。

3. 项目的配置文件介绍

app.yaml

app.yaml 是项目的配置文件，用于配置Google App Engine的运行环境。以下是文件的主要内容：

application: your-app-id
version: 1
runtime: python27
api_version: 1
threadsafe: true

handlers:
- url: /.*
  script: helloworld_api.APPLICATION

libraries:
- name: endpoints
  version: 1.0

配置文件介绍

• application: 指定应用的ID。
• version: 指定应用的版本号。
• runtime: 指定运行时环境，这里是Python 2.7。
• api_version: 指定API版本。
• threadsafe: 指定应用是否线程安全。
• handlers: 定义URL处理程序。
  • url: /.*: 匹配所有URL。
  • script: helloworld_api.APPLICATION: 指定处理请求的脚本。
• libraries: 指定需要加载的库，这里是Google Cloud Endpoints。

---

以上是 appengine-endpoints-helloendpoints-python 项目的安装与使用教程，希望对你有所帮助。

appengine-endpoints-helloendpoints-python项目地址:https://gitcode.com/gh_mirrors/ap/appengine-endpoints-helloendpoints-python