Bootstrap Bootstrap

ABCDE API 문서

ABCDE API 문서에 오신 것을 환영합니다. 이 API는 데이터를 생성, 조회, 업데이트 및 삭제할 수 있도록 합니다.

기본 URL

https://www.한뼘코딩.com/api

엔드포인트

1. 데이터 생성

엔드포인트: /abcde
메서드: POST
설명: 새로운 데이터를 생성합니다.

요청 본문:

{
        "program_key": "string",  // 프로그램의 고유 식별자
        "a": "string",            // 데이터 필드 A
        "b": "string",            // 데이터 필드 B
        "c": "string",            // 데이터 필드 C
        "d": "string",            // 데이터 필드 D
        "e": "string"             // 데이터 필드 E
    }
    

응답:

{
        "message": "Data entry created successfully"
    }
    

요청 예시:

curl -X POST https://www.한뼘코딩.com/api/abcde \
        -H "Content-Type: application/json" \
        -d '{
                "program_key": "abc123",
                "a": "value1",
                "b": "value2",
                "c": "value3",
                "d": "value4",
                "e": "value5"
            }'
    

2. 데이터 목록 조회

엔드포인트: /abcde/<program_key>
메서드: GET
설명: 특정 프로그램의 데이터 목록을 조회합니다.

URL 파라미터:

program_key (string): 프로그램의 고유 식별자.

응답:

[
        {
            "id": "integer",             // 데이터 항목의 ID
            "timestamp": "ISO 8601 string", // 데이터 생성 시간
            "program_key": "string",     // 프로그램의 고유 식별자
            "a": "string",               // 데이터 필드 A
            "b": "string",               // 데이터 필드 B
            "c": "string",               // 데이터 필드 C
            "d": "string",               // 데이터 필드 D
            "e": "string"                // 데이터 필드 E
        },
        ...
    ]
    

요청 예시:

curl https://www.한뼘코딩.com/api/abcde/abc123
    

3. 데이터 업데이트

엔드포인트: /abcde/<id>
메서드: PUT
설명: 기존 데이터를 업데이트합니다.

요청 본문:

{
        "a": "string",            // 데이터 필드 A
        "b": "string",            // 데이터 필드 B
        "c": "string",            // 데이터 필드 C
        "d": "string",            // 데이터 필드 D
        "e": "string"             // 데이터 필드 E
    }
    

응답:

{
        "message": "Data entry updated successfully"
    }
    

요청 예시:

curl -X PUT https://www.한뼘코딩.com/api/abcde/1 \
        -H "Content-Type: application/json" \
        -d '{
                "a": "new_value1",
                "b": "new_value2",
                "c": "new_value3",
                "d": "new_value4",
                "e": "new_value5"
            }'
    

4. 데이터 삭제

엔드포인트: /abcde/<id>
메서드: DELETE
설명: 데이터를 삭제합니다.

응답:

{
        "message": "Data entry deleted successfully"
    }
    

요청 예시:

curl -X DELETE https://www.한뼘코딩.com/api/abcde/1
    

주의사항

  • 제공된 program_key가 각 프로그램마다 고유하도록 하여 충돌을 피하십시오.
  • 데이터를 업데이트하거나 삭제할 때, 해당 데이터 항목이 존재하지 않으면 404 상태 코드와 함께 에러 메시지가 반환됩니다.

결론

이 API는 데이터를 생성, 조회, 업데이트 및 삭제할 수 있는 간단한 인터페이스를 제공합니다. 질문이나 문제가 있을 경우 API 관리자에게 문의하십시오.