Files
Stephen Zhou 92016aa139 fix(api): align Service API OpenAPI contract (#41248)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-08-25 10:54:14 +00:00

74 lines
2.6 KiB
Python

"""
Unit tests for Service API Index endpoint
"""
from unittest.mock import patch
import pytest
from flask import Flask
from controllers.service_api import bp as service_api_bp
from controllers.service_api import index as index_module
from controllers.service_api.index import IndexApi
def _get_index_response(app: Flask, version: str) -> dict[str, str]:
with patch.object(index_module.dify_config.project, "version", version):
with app.test_request_context("/", method="GET"):
index_api = IndexApi()
return index_api.get()
class TestIndexApi:
"""Test suite for IndexApi resource."""
def test_get_returns_api_info(self, app: Flask):
"""Test that GET returns API metadata with correct structure."""
# Act
response = _get_index_response(app, "1.0.0-test")
# Assert
assert response["welcome"] == "Dify OpenAPI"
assert response["api_version"] == "v1"
assert response["server_version"] == "1.0.0-test"
def test_get_response_has_required_fields(self, app: Flask):
"""Test that response contains all required fields."""
# Act
response = _get_index_response(app, "1.11.4")
# Assert
assert "welcome" in response
assert "api_version" in response
assert "server_version" in response
assert isinstance(response["welcome"], str)
assert isinstance(response["api_version"], str)
assert isinstance(response["server_version"], str)
@pytest.mark.parametrize("version", ["0.0.1", "1.0.0", "2.0.0-beta", "1.11.4"])
def test_get_returns_correct_version(self, app: Flask, version):
"""Test that server_version matches config version."""
# Act
response = _get_index_response(app, version)
# Assert
assert response["server_version"] == version
def test_root_route_returns_public_api_info(self):
"""Exercise the registered blueprint so Flask-RESTX cannot shadow the resource."""
app = Flask(__name__)
app.config["TESTING"] = True
app.register_blueprint(service_api_bp)
with patch.object(index_module.dify_config.project, "version", "1.0.0-route-test"):
response = app.test_client().get("/v1/")
assert response.status_code == 200
assert response.get_json() == {
"welcome": "Dify OpenAPI",
"api_version": "v1",
"server_version": "1.0.0-route-test",
}
root_rules = [rule for rule in app.url_map.iter_rules() if rule.rule == "/v1/"]
assert [rule.endpoint for rule in root_rules] == ["service_api.root"]