Maplestory-openapi

업데이트 내용
2024년 3월 21일 Nexon Open API 업데이트에 반영된 메이플스토리 API 실시간 조회 기능 대응, 유니온 프리셋 조회 추가 및 버그 수정

버그 수정
API 응답 누락
- [C] 일부 항목이 역직렬화되지 않는 버그를 수정하였습니다.

변경 사항
실시간 API 적용
- `캐릭터 정보 조회`, `유니온 정보 조회` API가 실시간 조회 기능을 제공합니다.
- API를 호출할 때 날짜를 특정하지 않으면 실시간 데이터를 조회할 수 있습니다.
주석 업데이트
- `캐릭터 정보 조회`, `유니온 정보 조회` API 목록의 주석이 공식문서와 일치하도록 더 자세하게 수정되었습니다.
유니온 프리셋
- 유니온 공격대 정보를 조회할 때 프리셋 정보가 같이 제공됩니다.
문서화
- 한글 REAMDE를 우선으로 표시하도록 변경하였습니다.

업데이트 내용
2023년 12월 28일 Nexon Open API 업데이트에 반영된 메이플스토리 스타포스 API와 대응되는 메소드 목록 구현 및 버그 수정

신규 기능
확률 정보 조회
- 스타포스 강화 결과 조회
변경 사항
DTO 클래스 관련
- DTO 클래스의 프로퍼티 중 날짜를 표현하는 데이터는 해당 언어의 **내장 날짜 클래스**를 사용하도록 변경되었습니다.
- [JS] `CharacterHyperStatInfoDto` → `CharacterHyperStatPresetDto`로 명칭 변경되었습니다.
- [JS, C] DTO 클래스의 프로퍼티가 nullable 타입인지 더 자세하게 표현하도록 변경되었습니다.
- [Java] `GuildDTO`에서 `getOguildId()` → `getOGuildId()`로 대체되었습니다.
- [Java] `CharacterItemEquipmentInfoDTO`에서 `getGender()` → `getItemGender()`로 대체되었습니다.
- [C] `CharacterDTO`에서 `Ocid` → `OCID`로 대체되었습니다.
- [C] `CharacterItemEquipmentInfoDTO`에서 `Gender` → `ItemGender`로 대체되었습니다.
DTO 클래스 디렉토리 변경
API 호출의 결과물인 DTO 클래스를 좀 더 세분화된 디렉토리로 나누어 제공하게 되었습니다.
- [Java] DTO 클래스의 패키지 위치가 다음과 같이 변경되었습니다.
- 변경 전
java
package dev.spiralmoon.maplestory.api.dto.*;

- 변경 후
java
package dev.spiralmoon.maplestory.api.dto.character.*;
package dev.spiralmoon.maplestory.api.dto.guild.*;
package dev.spiralmoon.maplestory.api.dto.history.*;
package dev.spiralmoon.maplestory.api.dto.ranking.*;
package dev.spiralmoon.maplestory.api.dto.union.*;


버그 수정
API 호출 버그 수정
- [Java, C] `CharacterItemEquipmentInfoDTO`에서 성별 데이터가 항상 `null`로 제공되던 버그 수정
- [C] `CharacterDTO`의 캐릭터 식별자가 항상 `null`로 제공되던 버그 수정
- [C] `GetCharacterCashItemEquipment()`의 반환값이 `CharacterAndroidCashItemEquipmentDTO`로 되어있던 버그 수정

업데이트 내용
API 동작 버그를 수정하였습니다.

버그 수정
기본 날짜 지정
- API의 파라미터로 날짜를 지정하지 않았을 때 사용되는 `기본 날짜`가 API의 요구사항과 다르게 생성되던 버그를 수정하였습니다. 이제부터 **조회 가능한 날짜 중 가장 최신 날짜를 생성**합니다.
유효하지 않은 API path
API의 path가 잘 못 설정된 버그를 수정하였습니다.
- [C] 캐릭터 기본 정보 조회
- [C] 캐릭터 캐시 장비 아이템 조회
유효하지 않은 파라미터
- [C] 길드 식별자 정보 조회 API가 길드 식별자를 파라미터로 받던 문제를 수정하였습니다.

변경 사항
주석 업데이트
- `캐릭터 정보 조회`, `유니온 정보 조회`, `길드 정보 조회` API 목록의 주석이 공식문서와 일치하도록 더 자세하게 수정되었습니다.
- 조회 기준일 주석의 일관성을 통일하였습니다.
파라미터 타입 업데이트
- [Java] 일부 API 파라미터의 nullable을 제한하기 위해 `NonNull` 어노테이션이 적용되었습니다.
- [Java, C] 일부 API 파라미터의 nullable을 제한하기 위해 자료형 변경이 적용되었습니다.
지원 종료
캐릭터 정보 조회
- `getCharacterBasicInfo()`가 `getCharacterBasic()`로 대체되었습니다.

업데이트 내용
2023년 12월 22일 Nexon Open API 업데이트에 반영된 메이플스토리 신규 API와 대응되는 메소드 목록 구현.

신규 기능
캐릭터 정보 조회
- 캐릭터 식별자 조회
- 기본 정보 조회
- 인기도 정보 조회
- 종합 능력치 정보 조회
- 하이퍼스탯 정보 조회
- 성향 정보 조회
- 어빌리티 정보 조회
- 장착 장비 정보 조회 (캐시 장비 제외)
- 장착 캐시 장비 정보 조회
- 장착 심볼 정보 조회
- 적용 세트 효과 정보 조회
- 장착 헤어, 성형, 피부 정보 조회
- 장착 안드로이드 정보 조회
- 장착 펫 정보 조회
- 스킬 정보 조회
- 장착 링크 스킬 정보 조회
- V매트릭스 정보 조회
- HEXA 코어 정보 조회
- HEXA 매트릭스 설정 HEXA 스탯 정보 조회
- 무릉도장 최고 기록 정보 조회
유니온 정보 조회
- 유니온 정보 조회
- 유니온 공격대 정보 조회
길드 정보 조회
- 길드 식별자 정보 조회
- 기본 정보 조회
랭킹 정보 조회
- 종합 랭킹 정보 조회
- 유니온 랭킹 정보 조회
- 길드 랭킹 정보 조회
- 무릉도장 랭킹 정보 조회
- 더 시드 랭킹 정보 조회
- 업적 랭킹 정보 조회
변경 사항
큐브 정보 조회
- 메소드명 변경 `getCubeResult` → `getCubeHistory`
- 날짜 지목 시 `year`, `month`, `day`를 별개의 파라미터로 입력받던 오버로딩 메소드를 제거하고 `DateTimeOffset`, `LocalDateTime`을 이용하도록 변경

업데이트 내용
새롭게 리뉴얼된 Nexon Open API 기반으로 시스템을 변경하였습니다.

변경 사항
API 기반 시스템 변경 Nexon Developers → Nexon Open API