onsdigital/eq-lookup-api

eQ Lookup API

镜像概述和主要用途

eQ Lookup API是一个轻量级请求服务API，主要功能是接收查询请求并返回结果列表。适用于需要简单信息查询功能的场景，如国家信息检索等，用户可通过浏览器或HTTP请求与API交互获取所需数据。

核心功能和特性

• 提供简单的请求处理服务，接收查询参数并返回结构化结果列表
• 支持通过浏览器访问API根地址获取搜索选项
• 支持国家信息查询，通过指定查询参数获取相关结果

使用场景和适用范围

• 开发环境中需要快速实现基础信息查询功能的应用
• 对国家等基础数据有查询需求的轻量级服务
• 作为简单API服务原型进行功能验证和测试

详细使用方法和配置说明

前置准备

1. 确保系统已安装pipenv工具
2. 克隆项目仓库：

   bash
   $ git clone https://github.com/ONSdigital/eq-lookup-api.git
   

在虚拟环境中运行

1. 进入项目目录：

   bash
   $ cd eq-lookup-api
   

2. 安装依赖并激活虚拟环境：

   bash
   $ pipenv install --dev
   $ pipenv shell
   Spawning environment shell (/bin/bash). Use 'exit' to leave.
   

3. 配置环境变量并启动服务：

   bash
   $ FLASK_APP=application.py LOOKUP_URL='lookup_url' flask run
   [2018-04-10 14:05:11.419541] INFO: app: Logging configured
    * Serving Flask app "application"
    * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
   

API使用方法

1. 浏览API功能：在浏览器中访问http://localhost:5000，即可查看可用的搜索选项。

2. 国家信息查询：通过以下URL格式进行国家查询：

   http://localhost:5000/country/?q=CountryName
   

   示例：查询名称包含"United"的国家

   http://localhost:5000/country/?q=United
   

注意事项

• 当请求API根资源（http://localhost:5000）时，q参数将被忽略，仅返回搜索选项。