API 문서 생성을 위해 PHP 및 Swagger를 사용하는 방법
인터넷의 급속한 발전과 함께 API(애플리케이션 프로그래밍 인터페이스)는 현대 애플리케이션 개발의 표준 방식이 되었습니다. API는 애플리케이션이 데이터와 기능을 교환할 수 있도록 하는 인터페이스 집합을 말하며, 애플리케이션이 서로 편리하고 빠르게 상호 작용할 수 있도록 해줍니다.
API를 만든 후 다른 개발자가 API를 쉽게 사용할 수 있도록 API에 대한 자세한 문서를 작성해야 합니다. 그러나 API 문서를 수동으로 작성하는 것은 시간과 에너지가 많이 소모되는 작업이므로 API 문서 생성을 위해 자동화된 도구를 사용하는 것이 매우 필요하고 효과적입니다.
이 글에서는 API 문서 생성을 위해 PHP와 Swagger를 사용하는 방법을 소개합니다.
1. 스웨거란?
Swagger는 RESTful API를 설명하고 정의하기 위한 사양입니다. 사람이 읽을 수 있는 문서를 생성하는 데 사용할 수 있을 뿐만 아니라 클라이언트 측 및 서버 측 코드를 생성하는 코드 생성기도 사용할 수 있습니다. Swagger는 API 테스트 및 디버깅에도 사용할 수 있습니다.
2. Swagger 설치 및 구성
Swagger를 사용하여 API 문서를 생성하려면 먼저 Swagger를 설치해야 합니다. Composer를 사용하여 Swagger를 설치할 수 있습니다. Composer는 PHP용 종속성 관리자이며 최신 버전의 Swagger를 다운로드할 수 있습니다.
Swagger를 설치하려면 다음 명령을 사용하세요.
composer require "swagger-api/swagger-ui:^3.50"
설치가 완료된 후 Swagger에 대한 몇 가지 구성을 수행해야 합니다. 프로젝트 루트 디렉토리에 swagger.php 파일을 생성하고 다음 코드를 추가합니다:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenApiAnnotations as OA;
$swagger = OpenApiscan('/path/to/your/controllers');
header('Content-Type: application/json');
echo $swagger;위 코드에서 /path/to/your/controllers는 자신의 컨트롤러 경로로 대체되어야 합니다. 또한, Composer.json 파일에 몇 가지 구성을 추가해야 합니다.
"config": {
"platform": {
"php": "7.4"
}
},
"autoload": {
"classmap": [
"app/",
"database/",
"routes/",
"tests/"
]
},
"require": {
"php": "^7.4",
"laravel/framework": "^8.40",
"tymon/jwt-auth": "^1.0",
"doctrine/dbal": "^2.13",
"swagger-api/swagger-ui": "^3.50"
},
"require-dev": {
"facade/ignition": "^2.5",
"fzaninotto/faker": "^1.9.1",
"mockery/mockery": "^1.4.2",
"nunomaduro/collision": "^6.0",
"phpunit/phpunit": "^9.3.3"
},3. Swagger를 사용하여 API 문서 생성
Swagger를 설치하고 구성한 후 이를 사용하여 API 문서를 생성할 수 있습니다. 다음 명령을 사용하여 API 문서를 생성할 수 있습니다.
php swagger.php > swagger.json
위 명령에서 swagger.php는 방금 생성한 Swagger 구성 파일이고 swagger.json은 우리가 생성한 API 문서 파일입니다.
4. Swagger UI를 사용하여 API 문서 표시
API 문서를 생성한 후 다른 사람이 볼 수 있도록 표시하려고 합니다. Swagger UI를 사용하여 API 문서를 표시할 수 있습니다. Swagger UI는 RESTful API 정보와 Swagger에서 설명하는 구현을 표시하는 데 사용되는 JavaScript 라이브러리입니다.
공개 디렉토리의 index.php 파일에 다음 콘텐츠를 추가할 수 있습니다:
require_once(__DIR__ . '/../vendor/autoload.php');
$swagger = file_get_contents(__DIR__ . '/../swagger.json');
$swaggerData = json_decode($swagger, true);
?>
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Swagger UI</title>
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/swagger-ui-dist/swagger-ui.min.css" >
<style>
html
{
box-sizing: border-box;
overflow: -moz-scrollbars-vertical;
overflow-y: scroll;
}
*, *:before, *:after
{
box-sizing: inherit;
}
body
{
margin:0;
background: #fafafa;
}
</style>
</head>
<body>
<div id="swagger-ui"></div>
<script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist/swagger-ui-bundle.js"> </script>
<script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist/swagger-ui-standalone-preset.js"> </script>
<script>
window.onload = function() {
// Begin Swagger UI call region
const ui = SwaggerUIBundle({
url: "<?php echo '/swagger.json'; ?>",
dom_id: '#swagger-ui',
deepLinking: true,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
plugins: [
SwaggerUIBundle.plugins.DownloadUrl
],
layout: "StandaloneLayout"
})
// End Swagger UI call region
window.ui = ui
}
</script>
</body>
</html>위 코드에서는 생성된 API 문서를 아름다운 HTML 페이지로 표시할 수 있는 Swagger UI의 JavaScript 라이브러리를 사용합니다. 형태가 펼쳐집니다.
API 문서를 보여주는 샘플 페이지는 다음과 같습니다.
5. 결론
Swagger를 사용하면 API 문서를 쉽게 생성하고 관리할 수 있습니다. 이 기사에서는 PHP 및 Swagger를 사용하여 API 문서를 생성하는 방법을 소개합니다. 이 단계에는 Swagger 설치 및 구성, Swagger를 사용하여 API 문서 생성, Swagger UI를 사용하여 API 문서 표시가 포함됩니다. 나는 이 기사의 소개 이후 독자들이 쉽게 Swagger를 사용하여 자신의 API 문서를 생성할 수 있다고 믿습니다.
위 내용은 API 문서 생성을 위해 PHP 및 Swagger를 사용하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!
핫 AI 도구
Undresser.AI Undress
사실적인 누드 사진을 만들기 위한 AI 기반 앱
AI Clothes Remover
사진에서 옷을 제거하는 온라인 AI 도구입니다.
Undress AI Tool
무료로 이미지를 벗다
Clothoff.io
AI 옷 제거제
AI Hentai Generator
AI Hentai를 무료로 생성하십시오.
인기 기사
뜨거운 도구
메모장++7.3.1
사용하기 쉬운 무료 코드 편집기
SublimeText3 중국어 버전
중국어 버전, 사용하기 매우 쉽습니다.
스튜디오 13.0.1 보내기
강력한 PHP 통합 개발 환경
드림위버 CS6
시각적 웹 개발 도구
SublimeText3 Mac 버전
신 수준의 코드 편집 소프트웨어(SublimeText3)
뜨거운 주제
7546
15
1381
52
83
11
57
19
21
89
Ubuntu 및 Debian용 PHP 8.4 설치 및 업그레이드 가이드
Dec 24, 2024 pm 04:42 PM
PHP 8.4는 상당한 양의 기능 중단 및 제거를 통해 몇 가지 새로운 기능, 보안 개선 및 성능 개선을 제공합니다. 이 가이드에서는 Ubuntu, Debian 또는 해당 파생 제품에서 PHP 8.4를 설치하거나 PHP 8.4로 업그레이드하는 방법을 설명합니다.
PHP 개발을 위해 Visual Studio Code(VS Code)를 설정하는 방법
Dec 20, 2024 am 11:31 AM
VS Code라고도 알려진 Visual Studio Code는 모든 주요 운영 체제에서 사용할 수 있는 무료 소스 코드 편집기 또는 통합 개발 환경(IDE)입니다. 다양한 프로그래밍 언어에 대한 대규모 확장 모음을 통해 VS Code는
이전에 몰랐던 후회되는 PHP 함수 7가지
Nov 13, 2024 am 09:42 AM
숙련된 PHP 개발자라면 이미 그런 일을 해왔다는 느낌을 받을 것입니다. 귀하는 상당한 수의 애플리케이션을 개발하고, 수백만 줄의 코드를 디버깅하고, 여러 스크립트를 수정하여 작업을 수행했습니다.
PHP에서 HTML/XML을 어떻게 구문 분석하고 처리합니까?
Feb 07, 2025 am 11:57 AM
이 튜토리얼은 PHP를 사용하여 XML 문서를 효율적으로 처리하는 방법을 보여줍니다. XML (Extensible Markup Language)은 인간의 가독성과 기계 구문 분석을 위해 설계된 다목적 텍스트 기반 마크 업 언어입니다. 일반적으로 데이터 저장 AN에 사용됩니다
JWT (JSON Web Tokens) 및 PHP API의 사용 사례를 설명하십시오.
Apr 05, 2025 am 12:04 AM
JWT는 주로 신분증 인증 및 정보 교환을 위해 당사자간에 정보를 안전하게 전송하는 데 사용되는 JSON을 기반으로 한 개방형 표준입니다. 1. JWT는 헤더, 페이로드 및 서명의 세 부분으로 구성됩니다. 2. JWT의 작업 원칙에는 세 가지 단계가 포함됩니다. JWT 생성, JWT 확인 및 Parsing Payload. 3. PHP에서 인증에 JWT를 사용하면 JWT를 생성하고 확인할 수 있으며 사용자 역할 및 권한 정보가 고급 사용에 포함될 수 있습니다. 4. 일반적인 오류에는 서명 검증 실패, 토큰 만료 및 대형 페이로드가 포함됩니다. 디버깅 기술에는 디버깅 도구 및 로깅 사용이 포함됩니다. 5. 성능 최적화 및 모범 사례에는 적절한 시그니처 알고리즘 사용, 타당성 기간 설정 합리적,
문자열로 모음을 계산하는 PHP 프로그램
Feb 07, 2025 pm 12:12 PM
문자열은 문자, 숫자 및 기호를 포함하여 일련의 문자입니다. 이 튜토리얼은 다른 방법을 사용하여 PHP의 주어진 문자열의 모음 수를 계산하는 방법을 배웁니다. 영어의 모음은 A, E, I, O, U이며 대문자 또는 소문자 일 수 있습니다. 모음이란 무엇입니까? 모음은 특정 발음을 나타내는 알파벳 문자입니다. 대문자와 소문자를 포함하여 영어에는 5 개의 모음이 있습니다. a, e, i, o, u 예 1 입력 : String = "Tutorialspoint" 출력 : 6 설명하다 문자열의 "Tutorialspoint"의 모음은 u, o, i, a, o, i입니다. 총 6 개의 위안이 있습니다
PHP에서 늦은 정적 결합을 설명하십시오 (정적 : :).
Apr 03, 2025 am 12:04 AM
정적 바인딩 (정적 : :)는 PHP에서 늦은 정적 바인딩 (LSB)을 구현하여 클래스를 정의하는 대신 정적 컨텍스트에서 호출 클래스를 참조 할 수 있습니다. 1) 구문 분석 프로세스는 런타임에 수행됩니다. 2) 상속 관계에서 통화 클래스를 찾아보십시오. 3) 성능 오버 헤드를 가져올 수 있습니다.
php magic 방법 (__construct, __destruct, __call, __get, __set 등)이란 무엇이며 사용 사례를 제공합니까?
Apr 03, 2025 am 12:03 AM
PHP의 마법 방법은 무엇입니까? PHP의 마법 방법은 다음과 같습니다. 1. \ _ \ _ Construct, 객체를 초기화하는 데 사용됩니다. 2. \ _ \ _ 파괴, 자원을 정리하는 데 사용됩니다. 3. \ _ \ _ 호출, 존재하지 않는 메소드 호출을 처리하십시오. 4. \ _ \ _ get, 동적 속성 액세스를 구현하십시오. 5. \ _ \ _ Set, 동적 속성 설정을 구현하십시오. 이러한 방법은 특정 상황에서 자동으로 호출되어 코드 유연성과 효율성을 향상시킵니다.
